Home Reference Source

import Package from '@osjs/server/src/package.js'

public class | source

Package

OS.js Package Abstraction

Constructor Summary

Public Constructor
public	constructor(core: Core, options: PackageOptions) Create new instance

Member Summary

Public Members
public	core: Core
public	filename: string
public	metadata: PackageMetadata

Method Summary

Public Methods
public	action(method: string): boolean Run method on package script
public	async destroy() Destroys instance
public	init(): Promise<undefined> Initializes this package
public	resource(path: string): string Resolve an URL for resource
public	start(): Promise<undefined> Starts server scripts
public	validate(manifest: PackageMetadata[]): boolean Validates this package
public	watch(cb: Function): string Creates a watch in package dist

Public Constructors

public constructor(core: Core, options: PackageOptions) source

Create new instance

Params:

Name	Type	Attribute	Description
core	Core		Core reference
options	PackageOptions	optional	Instance options

Public Members

public core: Core source

public filename: string source

public metadata: PackageMetadata source

Public Methods

public action(method: string): boolean source

Run method on package script

Params:

Name	Type	Attribute	Description
method	string		Method name
...args	*	optional	Pass arguments

Return:

public async destroy() source

Destroys instance

public init(): Promise<undefined> source

Initializes this package

Return:

Promise<undefined>

public resource(path: string): string source

Resolve an URL for resource

Params:

Name	Type	Attribute	Description
path	string		Input path

Return:

public start(): Promise<undefined> source

Starts server scripts

Return:

Promise<undefined>

public validate(manifest: PackageMetadata[]): boolean source

Validates this package

Params:

Name	Type	Attribute	Description
manifest	PackageMetadata[]		Global manifest

Return:

public watch(cb: Function): string source

Creates a watch in package dist

Params:

Name	Type	Attribute	Description
cb	Function		Callback function on watch changes

Return:

Watched path