Options
All
  • Public
  • Public/Protected
  • All
Menu

An interface for a path based database for creating and storing values, which is agnostic to the particular type of store in the backend.

Hierarchy

  • IDisposable
    • IModelDB

Implemented by

Index

Properties

basePath

basePath: string

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

Optional collaborators

collaborators: ICollaboratorMap

A map of the currently active collaborators for the database, including the local user.

connected

connected: Promise<void>

A promise that resolves when the database has connected to its backend, if any.

isCollaborative

isCollaborative: boolean

Whether the database is collaborative.

isDisposed

isDisposed: boolean

Whether the database has been disposed.

isPrepopulated

isPrepopulated: boolean

Whether the database has been populated with model values prior to connection.

Methods

createList

createMap

createString

createValue

dispose

  • dispose(): void

get

getValue

  • getValue(path: string): JSONValue | undefined
  • Get a value at a path, or undefined if it has not been set That value must already have been created usingcreateValue`.

    Parameters

    • path: string

    Returns JSONValue | undefined

has

  • has(path: string): boolean

setValue

  • setValue(path: string, value: JSONValue): void

view

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

    Parameters

    • basePath: string

    Returns IModelDB

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

Generated using TypeDoc