Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Meta

.module. Meta

The Meta class implements the module.IMeta interface.

Implements

Constructor

Name Description
new Meta(id, spec, resolver)
Abstract

Constructs the metadata of a module.

Members

Name Description
_isLoaded : boolean
Protected

Indicates the value has been loaded or was specified.

alias : nonEmptyString

Gets the alias of the module.

config : Object

Gets the configuration of the module.

id : nonEmptyString

Gets the identifier of the module.

isConfigLoaded : boolean

Gets a value that indicates if the module's configuration has been loaded.

isLoaded : boolean

Gets a value that indicates if the module's value is directly available through the value property.

ranking : number

Gets the ranking of the module.

resolveId

Resolves a module identifier as if it were a dependency of this one.

value : any

Gets the value of the module, if it has been loaded already, or undefined, otherwise.

Methods

Name Description
loadAsync() : Promise

Loads the module and returns a promise for its value.

loadConfigAsync() : Promise.<Object>

Loads the configuration of the module and returns a promise for it.

Constructor Details

new Meta(id, spec, resolver)
Abstract

Constructs the metadata of a module.

Source: javascript/web/pentaho/_core/module/Meta.js, line 50

Parameters:
Name Default Value Summary
id : nonEmptyString

The identifier of the module.

spec : pentaho.module.spec.IMeta

The specification of the metadata of the module.

resolver : pentaho._core.module.Resolver
Optional

The module resolver function.

Members Details

_isLoaded: boolean
Protected

Indicates the value has been loaded or was specified.

Source: javascript/web/pentaho/_core/module/Meta.js, line 89

Implements:
alias: nonEmptyString

Gets the alias of the module.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 49

Implements:

See also: pentaho.module.IMeta#isConfigLoaded , pentaho.module.IMeta#loadConfigAsync

config: Object

Gets the configuration of the module.

When not yet loaded, or if the module has no configuration, returns null.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 116

Implements:
id: nonEmptyString

Gets the identifier of the module.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 30

Implements:

See also: pentaho.module.IMeta#config

isConfigLoaded: boolean

Gets a value that indicates if the module's configuration has been loaded.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 131

Implements:

See also: pentaho.module.IMeta#value

isLoaded: boolean

Gets a value that indicates if the module's value is directly available through the value property.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 93

Implements:
ranking: number

Gets the ranking of the module.

The ranking determines the order of the module amongst other modules.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 58

Implements:

See also: pentaho.module.util.resolveModuleId

resolveId:

Resolves a module identifier as if it were a dependency of this one.

Resolving makes moduleId absolute, relative to this one.

Afterwards, any applicable RequireJS contextual mapping configuration is applied.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 142

Implements:

See also: pentaho.module.IMeta#isLoaded , pentaho.module.IMeta#loadAsync

value: any

Gets the value of the module, if it has been loaded already, or undefined, otherwise.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 80

Methods Details

Implements:
loadAsync() : Promise

Loads the module and returns a promise for its value.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 69

Returns:
Name Description
Promise

A promise for the value of the module.

See also: pentaho.module.IMeta#value

Implements:
loadConfigAsync() : Promise.<Object>

Loads the configuration of the module and returns a promise for it.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 105

Returns:
Name Description
Promise.<Object>

A promise for the configuration of the module.

See also: pentaho.module.IMeta#config