SetupConfiguration

SetupConfiguration

A library of package management commands which are used by various interfaces around the software.

Constructor

new SetupConfiguration()

Source:

Members

(static) setupURL

Source:

A reference to the setup URL used under the current route prefix, if any

Methods

(async, static) checkPackage(type, name, manifest) → {Promise.<Object>}

Source:

Check with the server whether a package of a certain type is able to be installed or updated.

Parameters:
Name Type Description
type string

The package type to check

name string

The package name to check

manifest string

The manifest URL to check

Returns:

The return manifest

Type
Promise.<Object>

(async, static) getPackages(type) → {Promise.<Array.<Object>>}

Source:

Get an Array of available packages of a given type which may be installed

Parameters:
Name Type Description
type string
Returns:
Type
Promise.<Array.<Object>>

(static) getPackageScopes() → {Array.<string>}

Source:

Return the named scopes which can exist for packages. Scopes are returned in the prioritization order that their content is loaded.

Returns:

An array of string package scopes

Type
Array.<string>

(async, static) installDependencies(pkg) → {Promise.<void>}

Source:

Install a set of dependency modules which are required by an installed package

Parameters:
Name Type Description
pkg object

The package which was installed that requested dependencies

Returns:
Type
Promise.<void>

(async, static) installPackage(type, name, manifest) → {Promise.<object>}

Source:

Install a Package

Parameters:
Name Type Description
type string

The type of package being installed, in ["module", "system", "world"]

name string

The canonical package name

manifest string

The package manifest URL

Returns:

A Promise which resolves to the installed package manifest

Type
Promise.<object>