Class ConfigWithDefaults

Configurable object with defaults.

Index

Constructors

Methods

Constructors

constructor

new ConfigWithDefaults(options: ConfigWithDefaults.IOptions): ConfigWithDefaults
Create a new config with defaults.
Parameters
- options: ConfigWithDefaults.IOptions
Returns ConfigWithDefaults
- Defined in packages/services/src/config/index.ts:221

Methods

get

get(key: string): JSONValue
Get data from the config section or fall back to defaults.
Parameters
- key: string
Returns JSONValue
- Defined in packages/services/src/config/index.ts:230

set

set(key: string, value: JSONValue): Promise<JSONValue>
Set a config value.

Notes
Uses the Jupyter Server API.

The promise is fulfilled on a valid response and rejected otherwise.

Sends the update to the server, and changes our local copy of the data immediately.
Parameters
- key: string
- value: JSONValue
Returns Promise<JSONValue>
- Defined in packages/services/src/config/index.ts:246