variableRef

Call Signature

variableRef(name): VariableRefSpec

Defined in: extract/spec.ts:1141

Reference a bound variable from a ForEachSpec scope.

Parameters

name

string

Returns

VariableRefSpec

Example

variableRef('name')                                   // the bound value itself
variableRef('item', ['address', 'city'])              // navigate into bound value (positional)
variableRef('item', ['age'], 'number')                // navigate + type check (positional)
variableRef('item', { path: ['age'], extract: 'number' }) // options object form
variableRef('x', { extract: 'string' })               // options without path

Call Signature

variableRef(name, options): VariableRefSpec

Defined in: extract/spec.ts:1142

Reference a bound variable from a ForEachSpec scope.

Parameters

name

string

options

VariableRefOptions

Returns

VariableRefSpec

Example

variableRef('name')                                   // the bound value itself
variableRef('item', ['address', 'city'])              // navigate into bound value (positional)
variableRef('item', ['age'], 'number')                // navigate + type check (positional)
variableRef('item', { path: ['age'], extract: 'number' }) // options object form
variableRef('x', { extract: 'string' })               // options without path

Call Signature

variableRef(name, path, extract?): VariableRefSpec

Defined in: extract/spec.ts:1146

Reference a bound variable from a ForEachSpec scope.

Parameters

name

string

path

readonly (string | number)[]

extract?

string

Returns

VariableRefSpec

Example

variableRef('name')                                   // the bound value itself
variableRef('item', ['address', 'city'])              // navigate into bound value (positional)
variableRef('item', ['age'], 'number')                // navigate + type check (positional)
variableRef('item', { path: ['age'], extract: 'number' }) // options object form
variableRef('x', { extract: 'string' })               // options without path