Skip to main content

Functions

Less than 1 minute

Functions

Defaults(basePath)open in new window

JSON config.

Returns: Partial<Config>

Arguments:

basePath: string

Dynamics()open in new window

Provided dynamically by server.

Returns: Partial<Config>

Arguments: none

Envs(basePath)open in new window

ENV variable (key/value) map.

Returns: Partial<Config>

Arguments:

basePath: string

Local()open in new window

Development config.

Returns: Partial<Config>

Arguments: none

Profile(profile)open in new window

Profile

Returns: Config

Arguments:

profile: string

Remote(target, [authenticationToken])open in new window

Returns: Partial<Config>

Arguments:

target: undefined | string

authenticationToken: string

SaveConfig(_)open in new window

Returns: Promise<void>

Arguments:

_: Config

Storage()open in new window

Load config from storage.

Returns: Promise<Partial<Config>>

Arguments: none

definitions(options)open in new window

Returns: object

Arguments:

options: ConfigPluginOpts

mapFromKeyValues(spec, values)open in new window

Maps the given objects onto a flattened set of (key x values).

Expects parsed yaml content of the form:

ENV_VAR:
 path: config.selector.path

Returns: object

Arguments:

spec: MappingSpec

values: Record<string, any>

mapToKeyValues(spec, values)open in new window

Maps the given flattend set of (key x values) onto a JSON object.

Returns: Record<string, any>

Arguments:

spec: MappingSpec

values: any

validateConfig(config)open in new window

Validate config object.

Returns: Config

Arguments:

config: Config