Class ModelDB

constructor

• new ModelDB(options?): ModelDB

• Constructor for the ModelDB.

  Parameters

  • Optional options: ModelDB.ICreateOptions

  Returns ModelDB

Readonly connected

Readonly isCollaborative

Readonly isPrepopulated

basePath

• get basePath(): string

• The base path for the ModelDB. This is prepended to all the paths that are passed in to the member functions of the object.

  Returns string

isDisposed

• get isDisposed(): boolean

• Whether the database is disposed.

  Returns boolean

createList

• createList<T>(path): IObservableUndoableList<T>

• Create an undoable list and insert it in the database.

  Type Parameters

  • T extends JSONValue

  Parameters

  • path: string

  Returns IObservableUndoableList<T>

  the list that was created.

  Notes

  The list can only store objects that are simple JSON Objects and primitives.

createMap

• createMap(path): IObservableJSON

• Create a map and insert it in the database.

  Parameters

  • path: string

  Returns IObservableJSON

  the map that was created.

  Notes

  The map can only store objects that are simple JSON Objects and primitives.

createString

• createString(path): IObservableString

• Create a string and insert it in the database.

  Parameters

  • path: string

  Returns IObservableString

  the string that was created.

createValue

• createValue(path): IObservableValue

• Create an opaque value and insert it in the database.

  Parameters

  • path: string

  Returns IObservableValue

  the value that was created.

dispose

• dispose(): void

• Dispose of the resources held by the database.

  Returns void

get

• get(path): IObservable

• Get a value for a path.

  Parameters

  • path: string

  Returns IObservable

  an IObservable.

getValue

• getValue(path): JSONValue

• Get a value at a path, or undefined if it has not been set That value must already have been created using createValue`.

  Parameters

  • path: string

  Returns JSONValue

has

• has(path): boolean

• Whether the IModelDB has an object at this path.

  Parameters

  • path: string

  Returns boolean

  a boolean for whether an object is at path.

set

• set(path, value): void

• Set a value at a path. Not intended to be called by user code, instead use the create* factory methods.

  Parameters

  • path: string

  • value: IObservable

  Returns void

setValue

• setValue(path, value): void

• Set a value at a path. That value must already have been created using createValue.

  Parameters

  • path: string

  • value: JSONValue

  Returns void

view

• view(basePath): ModelDB

• Create a view onto a subtree of the model database.

  Parameters

  • basePath: string

  Returns ModelDB

  an IModelDB with a view onto the original IModelDB, with basePath prepended to all paths.