Skip to main content
Pentaho Documentation

IInstanceResolve

pentaho.type.spec.IInstanceResolve

The spec.IInstanceResolve interface describes a special syntax used for resolving instances from a Type API instance container.

Resolve instance by id syntax

Denotes the named instance with the given id. The instance must be registered.

{$instance: {id: "my/service"}}

The isRequired property can also be specified.

Resolve instance by element type syntax

Denotes the highest ranking registered instance of a given element type.

{$instance: {type: "my/Service"}}

The properties filter and isRequired can also be specified.

Resolve instance by list type syntax

Denotes the list of all of the registered instances of the given list type's element type, ordered from highest to lowest ranking.

{$instance: {type: ["my/Service"]}}

The properties filter and isRequired can also be specified.

Source: doc-js/pentaho/type/spec/IInstanceResolve.jsdoc, line 17

See also:  pentaho.type.spec.UInstanceReference

Members

Name Description
base : UTypeReference

A reference to the base type of the denoted types.

filter : function

An instance predicate function that restricts the set of denoted instances.

id : nonEmptyString

The identifier of the desired instance.

isRequired : boolean

Indicates that there must be at least one instance being denoted.

type : UTypeReference

A reference to the type of the denoted instance.

Members Details

base: UTypeReference

A reference to the base type of the denoted types.

The base type itself is also denoted.

Source: doc-js/pentaho/type/spec/ITypesResolve.jsdoc, line 39

filter: function

An instance predicate function that restricts the set of denoted instances.

Source: doc-js/pentaho/type/spec/IInstanceResolve.jsdoc, line 81

id: nonEmptyString

The identifier of the desired instance.

Source: doc-js/pentaho/type/spec/IInstanceResolve.jsdoc, line 65

isRequired: boolean

Indicates that there must be at least one instance being denoted.

When type is a list type, this refers to the list's elements.

Source: doc-js/pentaho/type/spec/IInstanceResolve.jsdoc, line 89

type: UTypeReference

A reference to the type of the denoted instance.

Source: doc-js/pentaho/type/spec/IInstanceResolve.jsdoc, line 73