An interface for a path based database for creating and storing values, which is agnostic to the particular type of store in the backend.
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 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.
Get a value at a path, or
undefined if it has not been set
That value must already have been created usingcreateValue`.
IModelDB has an object at this path.
a boolean for whether an object is at
Set a value at a path. That value must already have
been created using
Create a view onto a subtree of the model database.
IModelDB with a view onto the original
basePath prepended to all paths.
Generated using TypeDoc