import Packages from '@osjs/client/src/packages.js'

public class | source

Packages

Package Manager

Handles indexing, loading and launching of OS.js packages

Constructor Summary

Public Constructor
public	constructor(core: Core) Create package manage

Member Summary

Public Members
public	core: Core Core instance reference
public	inited: boolean If inited
public	metadata: PackageMetadata[] The lost of loaded package metadata
public	packages: PackageReference[] A list of registered packages
public	preloader: Preloader Preloader

Private Members
private	_running: string[] A list of running application names

Method Summary

Public Methods
public	addPackages(list: PackageMetadata[]): PackageMetadata[] Adds a set of packages
public	destroy() Destroy package manager
public	getCompatiblePackages(mimeType: string): PackageMetadata[] Gets a list of packages compatible with the given mime type
public	getMetadataFromName(name: string): PackageMetadata Gets the package metadata for a given package name
public	getPackages(filter: Function): PackageMetadata[] Gets a list of packages (metadata)
public	init(): Promise<boolean> Initializes package manager
public	launch(name: string, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> Launches a (application) package
public	register(name: string, callback: Function) Registers a package
public	running(): string[] Gets a list of running packages

Private Methods
private	_autostart() Autostarts tagged packages
private	_getPreloads(metadata: Metadata, fileType: string, packageType: string): string[] Returns preloads
private	_launch(name: string, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> Wrapper for launching a (application) package
private	_launchApplication(name: string, metadata: Metadata, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> Launches an application package
private	_launchTheme(name: string, metadata: Metadata): Promise<object> Launches a (theme) package
private	_preloadBackgroundFiles(list: PackageMetadata[]): * Preloads background files of a set of packages

Public Constructors

public constructor(core: Core) source

Create package manage

Params:

Name	Type	Attribute	Description
core	Core		Core reference

Public Members

public core: Core source

Core instance reference

public inited: boolean source

If inited

public metadata: PackageMetadata[] source

The lost of loaded package metadata

public packages: PackageReference[] source

A list of registered packages

public preloader: Preloader source

Preloader

Private Members

private _running: string[] source

A list of running application names

Mainly used for singleton awareness

Public Methods

public addPackages(list: PackageMetadata[]): PackageMetadata[] source

Adds a set of packages

Params:

Name	Type	Attribute	Description
list	PackageMetadata[]		Package list

Return:

PackageMetadata[]

Current list of packages

public destroy() source

Destroy package manager

public getCompatiblePackages(mimeType: string): PackageMetadata[] source

Gets a list of packages compatible with the given mime type

Params:

Name	Type	Attribute	Description
mimeType	string		MIME Type

Return:

PackageMetadata[]

See:

PackageManager#getPackages

public getMetadataFromName(name: string): PackageMetadata source

Gets the package metadata for a given package name

Params:

Name	Type	Attribute	Description
name	string

Return:

PackageMetadata

public getPackages(filter: Function): PackageMetadata[] source

Gets a list of packages (metadata)

Params:

Name	Type	Attribute	Description
filter	Function	optional	A filter function

Return:

PackageMetadata[]

public init(): Promise<boolean> source

Initializes package manager

Return:

Promise<boolean>

public launch(name: string, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> source

Launches a (application) package

Params:

Name	Type	Attribute	Description
name	string		Package name
args	{foo: *}	optional default: {}	Launch arguments
options	PackageLaunchOptions	optional default: {}	Launch options

public register(name: string, callback: Function) source

Registers a package

Params:

Name	Type	Attribute	Description
name	string		Package name
callback	Function		Callback function to construct application instance

Throw:

Error

public running(): string[] source

Gets a list of running packages

Return:

string[]

Private Methods

private _autostart() source

Autostarts tagged packages

private _getPreloads(metadata: Metadata, fileType: string, packageType: string): string[] source

Returns preloads

Params:

Name	Type	Attribute	Description
metadata	Metadata		Application metadata
fileType	string		Files type
packageType	string		Package type

Return:

string[]

private _launch(name: string, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> source

Wrapper for launching a (application) package

Params:

Name	Type	Attribute	Description
name	string		Package name
args	{foo: *}		Launch arguments
options	PackageLaunchOptions		Launch options

Return:

Promise<Application>

private _launchApplication(name: string, metadata: Metadata, args: {foo: *}, options: PackageLaunchOptions): Promise<Application> source

Launches an application package

Params:

Name	Type	Attribute	Description
name	string		Application package name
metadata	Metadata		Application metadata
args	{foo: *}		Launch arguments
options	PackageLaunchOptions		Launch options

Return:

Promise<Application>

private _launchTheme(name: string, metadata: Metadata): Promise<object> source

Launches a (theme) package

Params:

Name	Type	Attribute	Description
name	string		Package name
metadata	Metadata		Application metadata

Return:

Promise<object>

Throw:

Error

private _preloadBackgroundFiles(list: PackageMetadata[]): * source

Preloads background files of a set of packages

Params:

Name	Type	Attribute	Description
list	PackageMetadata[]		Package list