Class ConfigWithDefaults

Configurable object with defaults.

Hierarchy

ConfigWithDefaults

Index

Constructors

Properties

_classData _className _defaults _section

Methods

Constructors

constructor

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

Properties

`Private` _classData

_classData: any

Get data from the Section with our classname, if available.

Notes

If we have no classname, get all of the data in the Section

`Private` _className

_className: any

`Private` _defaults

_defaults: any

`Private` _section

_section: any

Methods

get

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

set

set(key, value): 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/lib/config/index.d.ts:72

Generated using TypeDoc