WPMInterface

Methods

(static) onAllInstalled(callback)

Description:

• Registers a callback to be called when all packages are installed. (When installing multiple packages at the same time.)

Source:

• WPMv2.js, line 96

Example

wpm.onAllInstalled(()=>{
    //All packages are installed
});

Parameters:

(static) onInstalled(callback)

Description:

• Registers a callback to be called when this package is installed.

Source:

• WPMv2.js, line 79

Example

wpm.onInstalled(()=>{
    //Package is now installed
});

Parameters:

(static) onRemoved(callback)

Description:

• Registers a callback to be called when this package is removed.

Source:

• WPMv2.js, line 123

Example

wpm.onRemoved(({detail: packageName})=>{
    //Package is removed, packageName is provided for ease of access, will be same as the package this callback was registered from.
});

Parameters:

(static) onRemovedAny(callback)

Description:

• Registers a callback to be called when any package is removed.

Source:

• WPMv2.js, line 140

Example

wpm.onRemovedAny(({detail: packageName})=>{
     //Package with name "packageName" has been removed
});

Parameters:

(static) readMetadata(packageNameopt) → {json}

Description:

• Reads metadata from the given package. If no packagename is given, metadata from the current package is read.

Source:

• WPMv2.js, line 59

Example

let metadata = wpm.readMetadata();

Parameters:

Returns:

Type

json

(static) requireExternal(urls) → {Promise.<void>}

Description:

• Fetches and evaluates external javascript, or loads css. The server response header Content-Type will be used to determine if its a JS or CSS.

Source:

• WPMv2.js, line 236

Example

await wpm.requireExternal("https://some.site.com/someScript.js");
//someScript.js has now been parsed and evaluated

Parameters:

Returns:

Type

Promise.<void>