Class Config
Config
Class Declared in packages/sdk/config/dist/types/src/config.d.ts:37
Global configuration object. NOTE: Config objects are immutable.
Constructors
constructor([config], objects)
Creates an immutable instance.
Returns: Config
Arguments:
config
: Config
objects
: Config[]
Properties
values
Type: Config
Returns an immutable config JSON object.
Methods
find(path, test)
Get unique key.
Returns: undefined | T
Arguments:
path
: string
test
: object
get(key, [defaultValue])
Returns the given config property.
Returns: undefined | DeepIndex<Config, ParseKey<K>>
Arguments:
key
: K
defaultValue
: DeepIndex<Config, ParseKey<K>>
getOrThrow(key)
Returns the given config property or throw if it doesn't exist.
Returns: Exclude<DeepIndex<Config, ParseKey<K>>, undefined>
Arguments:
key
: K