Skip to main content
Pentaho Documentation

IRule

pentaho.config.spec. IRule

The config.spec.IRule interface describes a configuration rule, used to configure one or more types.

A configuration rule is part of a configuration rule set.

Source: doc-js/pentaho/config/spec/IRule.jsdoc, line 17

See also: pentaho.config.spec.IRuleSet

Members

Name Description
apply : Object | function

The actual configuration specification that is applied to the selected value type(s).

deps : Array.<string>

The absolute identifiers of the modules that should be loaded when the rule is selected for application.

priority : number

The priority of the configuration rule.

select : pentaho.config.spec.IRuleSelector

The criteria map that determines when a rule is selected for a given type and environment variables.

Members Details

apply: Object | function

The actual configuration specification that is applied to the selected value type(s).

Alternatively, if a function is specified, it will be called with the value of any dependencies declared in deps and it should return the final configuration object, or a Nully value, if it should be ignored.

Source: doc-js/pentaho/config/spec/IRule.jsdoc, line 52

deps: Array.<string>

The absolute identifiers of the modules that should be loaded when the rule is selected for application.

When relative, these are relative to pentaho.config.spec.IRuleSet#contextId. Also, if there are any applicable AMD/RequireJS mappings to contextId, these are applied.

Source: doc-js/pentaho/config/spec/IRule.jsdoc, line 64

See also: pentaho.config.spec.IRuleSet#contextId

priority: number

The priority of the configuration rule.

A rule's priority is the attribute that most influences its precedence order.

Source: doc-js/pentaho/config/spec/IRule.jsdoc, line 29

Default Value: 0

select: pentaho.config.spec.IRuleSelector

The criteria map that determines when a rule is selected for a given type and environment variables.

When the map is unspecified, it is like every selection variable had been specified with a null value.

Source: doc-js/pentaho/config/spec/IRule.jsdoc, line 40