Private
_changedPrivate
_clearClear the entire database.
Private
_connectorPrivate
_fetchFetch a value from the database.
Private
_listFetch a list from the database.
Private
_mergeMerge data into the state database.
Private
_overwriteOverwrite the entire database with new contents.
Private
_readyPrivate
_removeRemove a key in the database.
Private
_saveSave a key and its value in the database.
Retrieve a saved bundle from the database.
The identifier used to retrieve a data bundle.
A promise that bears a data payload if available.
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
.
Retrieve all the saved bundles for a namespace.
A promise that bears a collection of payloads for a namespace.
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.
Save a value in the database.
The identifier for the data being saved.
The data being saved.
A promise that is rejected if saving fails and succeeds otherwise.
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.
Generated using TypeDoc
The default concrete implementation of a state database.