The base path for the IModelDB
. This is prepended
to all the paths that are passed in to the member
functions of the object.
A map of the currently active collaborators for the database, including the local user.
A promise that resolves when the database has connected to its backend, if any.
Whether the database is collaborative.
Whether the database has been disposed.
Whether the database has been populated with model values prior to connection.
Create an undoable list and insert it in the database.
the list that was created.
The list can only store objects that are simple JSON Objects and primitives.
Create a map and insert it in the database.
the map that was created.
The map can only store objects that are simple JSON Objects and primitives.
Create a string and insert it in the database.
the string that was created.
Create an opaque value and insert it in the database.
the value that was created.
Dispose of the resources held by the database.
Get a value for a path.
an IObservable
.
Get a value at a path, or undefined if it has not been set
That value must already have been created using
createValue`.
Whether the IModelDB
has an object at this path.
a boolean for whether an object is at path
.
Set a value at a path. That value must already have
been created using createValue
.
Create a view onto a subtree of the model database.
an IModelDB
with a view onto the original
IModelDB
, with basePath
prepended to all paths.
Generated using TypeDoc
An interface for a path based database for creating and storing values, which is agnostic to the particular type of store in the backend.