Class StateDB<T>

Returns StateDB<T>

Returns ISignal<this, Change>

Returns Promise<void>

Returns Promise<undefined | T>

A promise that bears a data payload if available.

Notes

The id values of stored items in the state database are formatted: 'namespace:identifier', which is the same convention that command identifiers in JupyterLab use as well. While this is not a technical requirement for fetch(), remove(), and save(), it is necessary for using the list(namespace: string) method.

The promise returned by this method may be rejected if an error occurs in retrieving the data. Non-existence of an id will succeed with the value undefined.

Returns Promise<{
    ids: string[];
    values: T[];
}>

A promise that bears a collection of payloads for a namespace.

Notes

Namespaces are entirely conventional entities. The id values of stored items in the state database are formatted: 'namespace:identifier', which is the same convention that command identifiers in JupyterLab use as well.

If there are any errors in retrieving the data, they will be logged to the console in order to optimistically return any extant data without failing. This promise will always succeed.

Returns Promise<void>

A promise that is rejected if remove fails and succeeds otherwise.

Returns Promise<void>

A promise that is rejected if saving fails and succeeds otherwise.

Notes

The id values of stored items in the state database are formatted: 'namespace:identifier', which is the same convention that command identifiers in JupyterLab use as well. While this is not a technical requirement for fetch(), remove(), and save(), it is necessary for using the list(namespace: string) method.

Returns Promise<{
    [id: string]: T;
}>

A promise that resolves with the database contents as JSON.