Options
All
  • Public
  • Public/Protected
  • All
Menu

A concrete implementation of an IModelDB.

Hierarchy

  • ModelDB

Implements

Index

Constructors

constructor

  • Constructor for the ModelDB.

    Parameters

    Returns ModelDB

Properties

Private _basePath

_basePath: any

Private _db

_db: any

Private _disposables

_disposables: any

Private _isDisposed

_isDisposed: any

Private _resolvePath

_resolvePath: any

Compute the fully resolved path for a path argument.

Private _toDispose

_toDispose: any

Readonly connected

connected: Promise<void>

A promise resolved when the model is connected to its backend. For the in-memory ModelDB it is immediately resolved.

Readonly isCollaborative

isCollaborative: boolean

Whether the model is collaborative.

Readonly isPrepopulated

isPrepopulated: boolean

Whether the model has been populated with any model values.

Accessors

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

Methods

createList

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

    Type parameters

    • T: 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

  • 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

  • Create a string and insert it in the database.

    Parameters

    • path: string

    Returns IObservableString

    the string that was created.

createValue

  • 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 a value for a path.

    Parameters

    • path: string

    Returns IObservable

    an IObservable.

getValue

  • getValue(path: string): 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: string): 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 a value at a path. Not intended to be called by user code, instead use the create* factory methods.

    Parameters

    Returns void

setValue

  • setValue(path: string, value: JSONValue): void
  • Set a value at a path. That value must already have been created using createValue.

    Parameters

    • path: string
    • value: JSONValue

    Returns void

view

  • 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.

Generated using TypeDoc