Functions
Functions
Defaults(basePath)
JSON config.
Returns: Partial<Config>
Arguments:
basePath: string
Dynamics()
Provided dynamically by server.
Returns: Partial<Config>
Arguments: none
Envs(basePath)
ENV variable (key/value) map.
Returns: Partial<Config>
Arguments:
basePath: string
Local()
Development config.
Returns: Partial<Config>
Arguments: none
Profile(profile)
Profile
Returns: Config
Arguments:
profile: string
Remote(target, [authenticationToken])
Returns: Partial<Config>
Arguments:
target: undefined | string
authenticationToken: string
SaveConfig(_)
Returns: Promise<void>
Arguments:
_: Config
Storage()
Load config from storage.
Returns: Promise<Partial<Config>>
Arguments: none
definitions(options)
Returns: object
Arguments:
options: ConfigPluginOpts
mapFromKeyValues(spec, values)
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)
Maps the given flattend set of (key x values) onto a JSON object.
Returns: Record<string, any>
Arguments:
spec: MappingSpec
values: any
validateConfig(config)
Validate config object.
Returns: Config
Arguments:
config: Config