WASMUtils

WASMUtils

Source:

Members

(static) AScriptUtils

Utility class for dealing with AS compiled WASM.

Properties:
Name Type Description
lifTypedArray
Source:

(static) ASUtils

This namespace should have available all the modules that have been added into the AS-compiled web assembly folder.

Properties:
Name Type Description
matrixUtils_AS
timeSeries_AS
Source:

(static, constant) availableScripts

object container of relative paths for the Web Assembly modules

Source:

(static) CUtils

CUtils object containing the names of C module files to be interfaced.

Properties:
Name Type Description
matrixUtils_c
arima_c
monteCarlo_c
Source:

Methods

(static) _location(scName, utilName) → {string}

Returns the location of a specified utility in a given script or module.

Parameters:
Name Type Description
scName string

The name of the script or module.
utilName string

The name of the utility.
Source:
Returns:
  • The location of the specified utility in the given script or module.
Type
string

(async, static) ASModule(name) → {Promise}

Load and instantiate a WebAssembly module from the ASUtils script directory.

Parameters:
Name Type Description
name string

The name of the module to load.
Source:
Throws:
  • If the module cannot be loaded or instantiated.
Type
Error
Returns:
  • An object representing the exports of the instantiated module.
Type
Promise

(async, static) avScripts() → {Promise.<object>}

Retrieves all available scripts and their modules.

Source:
Returns:
  • A promise that resolves to an object containing all the available scripts and their modules.
Type
Promise.<object>

(async, static) CModule(moduleName) → {Promise}

Asynchronously loads and creates a module from a C script.

Parameters:
Name Type Description
moduleName string

The name of the module to load.
Source:
Throws:

Will throw an error if there was an error loading the module.

Returns:

A promise that resolves to the module.

Type
Promise

(static) filterFunctionKeys(obj) → {Array.<string>}

Filters the function keys of an object, excluding specific keys.

Parameters:
Name Type Description
obj object

The object to filter.
Source:
Returns:
  • An array of filtered function keys.
Type
Array.<string>

(async, static) getAllModules() → {Promise.<object>}

Retrieves all available modules.

Source:
Returns:
  • A promise that resolves to an object containing all the available modules.
Type
Promise.<object>

(async, static) loadModule(scriptName, moduleName) → {Promise.<object>}

Loads a module based on the script name and module name.

Parameters:
Name Type Description
scriptName string

The script name.
moduleName string

The module name.
Source:
Throws:
  • If the module is not found in the available scripts.
Type
NotFound
Returns:
  • A promise that resolves to the loaded module.
Type
Promise.<object>