Skip to main content
Pentaho Documentation

ITypeMeta

pentaho.module. ITypeMeta

The ITypeMeta interface contains the metadata of a type module.

Source: doc-js/pentaho/module/ITypeMeta.jsdoc, line 17

Extends

Members

Name Description
alias : nonEmptyString

Gets the alias of the module.

ancestor : pentaho.module.ITypeMeta

Gets the base type module.

config : Object

Gets the configuration of the module.

id : nonEmptyString

Gets the identifier of the module.

instances : Array.<!pentaho.module.IInstanceMeta>

Gets the array of instance modules, possibly empty.

isAbstract : boolean

Gets a value that indicates if the type module is abstract.

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.

kind : nonEmptyString

Gets the kind of module.

ranking : number

Gets the ranking of the module.

resolveId

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

subtypes : Array.<!pentaho.module.ITypeMeta>

Gets the array of subtypes, possibly empty.

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.

Members Details

alias: nonEmptyString

Gets the alias of the module.

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

Inherited From: pentaho.module.IMeta#alias

ancestor: pentaho.module.ITypeMeta

Gets the base type module.

When the type is a root type, null is returned.

Source: doc-js/pentaho/module/ITypeMeta.jsdoc, line 26

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

Inherited From: pentaho.module.IMeta#config

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

id: nonEmptyString

Gets the identifier of the module.

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

Inherited From: pentaho.module.IMeta#id

instances: Array.<!pentaho.module.IInstanceMeta>

Gets the array of instance modules, possibly empty.

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

isAbstract: boolean

Gets a value that indicates if the type module is abstract.

An abstract type module does not have a corresponding file or implementation. Its value is undefined.

Source: doc-js/pentaho/module/ITypeMeta.jsdoc, line 37

isConfigLoaded: boolean

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

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

Inherited From: pentaho.module.IMeta#isConfigLoaded

See also: pentaho.module.IMeta#config

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

Inherited From: pentaho.module.IMeta#isLoaded

See also: pentaho.module.IMeta#value

kind: nonEmptyString

Gets the kind of module.

One of the strings "type" or "instance".

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

Inherited From: pentaho.module.IMeta#kind

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

Inherited From: pentaho.module.IMeta#ranking

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

Inherited From: pentaho.module.IMeta#resolveId

See also: pentaho.module.util.resolveModuleId

subtypes: Array.<!pentaho.module.ITypeMeta>

Gets the array of subtypes, possibly empty.

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

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

Inherited From: pentaho.module.IMeta#value

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

Methods Details

loadAsync() : Promise

Loads the module and returns a promise for its value.

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

Inherited From: pentaho.module.IMeta#loadAsync

Returns:
Name Description
Promise

A promise for the value of the module.

See also: pentaho.module.IMeta#value

loadConfigAsync() : Promise.<Object>

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

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

Inherited From: pentaho.module.IMeta#loadConfigAsync

Returns:
Name Description
Promise.<Object>

A promise for the configuration of the module.

See also: pentaho.module.IMeta#config