Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WhiteboardRepository

A whiteboard repository.

Hierarchy

  • Disposable
    • WhiteboardRepository

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Disposable calling the provided function on dispose.

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns WhiteboardRepository

Properties

addRevision

addRevision: function

Adds a revisition.

param

The document to add.

returns

The promise.

Type declaration

current

current: WhiteboardRevision

Gets the current revision (if available).

get

get: function

Returns the a revision of a specific numver.

param

The revision number.

returns

The promise.

Type declaration

init

init: function

Initializes the repository.

returns

The promise.

Type declaration

    • (): PromiseLike<boolean>

    • Returns PromiseLike<boolean>

setBoard

setBoard: function

Resets the repository with a new board.

param

The new board.

returns

The promise.

Type declaration

Methods

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

Static from

  • from(...disposableLikes: object[]): Disposable

  • Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

    Parameters

    • Rest ...disposableLikes: object[]

      Objects that have at least a dispose-function member.

    Returns Disposable

    Returns a new disposable which, upon dispose, will dispose all provided disposables.

Generated using TypeDoc