IMeta

Last updated
Save as PDF

pentaho .module .spec. IMeta

The spec.IMeta interface contains the metadata of a module.

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

Members

Name	Description
alias : `nonEmptyString`	The alias of the module.
ranking : `number`	The ranking of the module.
value : `any \| function`	The value of the module or a function that creates it.

Members Details

alias: `nonEmptyString`
The alias of the module. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 30

alias: nonEmptyString

The alias of the module.

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

ranking: `number`
The ranking of the module. The ranking determines the order of the module amongst other modules. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 38 Default Value: 0

ranking: number

The ranking of the module.

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

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

Default Value: 0

value: `any \| function`
The value of the module or a function that creates it. When specified, an AMD/RequireJS module with this module's id is dynamically defined. Only considered specified when different from `undefined`. When a function, whatever its return value is taken as the value of the module. When a function, it is called with the module metadata object, having its configuration already loaded. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 49

value: any | function

The value of the module or a function that creates it.

When specified, an AMD/RequireJS module with this module's id is dynamically defined.

Only considered specified when different from undefined. When a function, whatever its return value is taken as the value of the module. When a function, it is called with the module metadata object, having its configuration already loaded.

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