Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigWithDefaults

Configurable object with defaults. A namespace for ConfigWithDefaults statics.

Hierarchy

  • ConfigWithDefaults

Index

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _className

_className: string = ""

Private _defaults

_defaults: JSONObject

Private _section

_section: IConfigSection

Methods

Private _classData

  • _classData(): JSONObject

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

    Notes

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

    Returns JSONObject

get

  • get(key: string): JSONValue

  • Get data from the config section or fall back to defaults.

    Parameters

    • key: string

    Returns JSONValue

set

  • set(key: string, value: JSONValue): Promise<JSONValue>

  • Set a config value.

    Notes

    Uses the Jupyter Notebook 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>

Generated using TypeDoc