Class VariableResolverService

The variable resolver service should be used to resolve variables in strings.

Index

Constructors

Properties

variableRegistry VAR_REGEXP

Methods

doResolve doResolveArray doResolveObject doResolveString resolve resolveArray resolveVariables

Constructors

constructor

new VariableResolverService(): VariableResolverService
Returns VariableResolverService

Properties

`Protected` `Readonly`variableRegistry

variableRegistry: VariableRegistry

`Protected` `Static`VAR_REGEXP

VAR_REGEXP: RegExp = ...

Methods

`Protected`doResolve

doResolve(value: any, context: VariableResolverService.Context): Promise<any>
Parameters
- value: any
- context: VariableResolverService.Context
Returns Promise<any>
- Defined in browser/variable-resolver-service.ts:75

`Protected`doResolveArray

doResolveArray(
values: (undefined | Object)[],
context: VariableResolverService.Context,
): Promise<(undefined | Object)[]>
Parameters
- values: (undefined | Object)[]
- context: VariableResolverService.Context
Returns Promise<(undefined | Object)[]>
- Defined in browser/variable-resolver-service.ts:104

`Protected`doResolveObject

doResolveObject(
obj: object,
context: VariableResolverService.Context,
): Promise<object>
Parameters
- obj: object
- context: VariableResolverService.Context
Returns Promise<object>
- Defined in browser/variable-resolver-service.ts:92

`Protected`doResolveString

doResolveString(
value: string,
context: VariableResolverService.Context,
): Promise<string>
Parameters
- value: string
- context: VariableResolverService.Context
Returns Promise<string>
- Defined in browser/variable-resolver-service.ts:113

resolve

resolve<T>(value: T, options?: VariableResolveOptions): Promise<undefined | T>
Resolve the variables for all strings found in the object and nested objects.
Type Parameters
- T
Parameters
- value: T
  Data to resolve variables in.
- options: VariableResolveOptions = {}
  Options of the variable resolution
Returns Promise<undefined | T>
Promise to object with variables resolved. Returns undefined if a variable resolution was cancelled.
- Defined in browser/variable-resolver-service.ts:63

resolveArray

resolveArray(
value: string[],
options?: VariableResolveOptions,
): Promise<undefined | string[]>
Resolve the variables in the given string array.
Parameters
- value: string[]
  The array of data to resolve variables in.
- options: VariableResolveOptions = {}
  Options of the variable resolution.
Returns Promise<undefined | string[]>
Promise to array with variables resolved. Never rejects.

Deprecated
since 1.28.0 use resolve instead.
- Defined in browser/variable-resolver-service.ts:53

`Protected`resolveVariables

resolveVariables(
value: string,
context: VariableResolverService.Context,
): Promise<void>
Parameters
- value: string
- context: VariableResolverService.Context
Returns Promise<void>
- Defined in browser/variable-resolver-service.ts:121