Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WhiteboardRepositoryBase

A basic whiteboard repository.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _CONFIG

_CONFIG: WhiteboardConfiguration

Stores the configuration for this repository.

Protected _CONTROLLER

_CONTROLLER: Controller

Stores the underlying controller.

Protected _current

_current: WhiteboardRevision

Stores the current revision.

Protected _nextRevisionNr

_nextRevisionNr: number = INITIAL_REVISION_NEXT_NR

The next revision ID.

Accessors

config

controller

current

Methods

Abstract addRevision

Protected clearDirectory

  • clearDirectory(): PromiseLike<boolean>

  • Clears the output directory.

    Returns PromiseLike<boolean>

    The promise.

Protected createDirectoryIfNeeded

  • createDirectoryIfNeeded(): PromiseLike<string>

  • Creates the output directory if needed.

    Returns PromiseLike<string>

    The promise.

Abstract dispose

  • dispose(): any

Protected forEachFile

  • forEachFile(cb: function): PromiseLike<boolean>

  • Invokes a callback for each whiteboard file.

    Parameters

    • cb: function

      The callback.

        • (data: Buffer, filePath: string, stats: Stats): void

        • Parameters

          • data: Buffer
          • filePath: string
          • stats: Stats

          Returns void

    Returns PromiseLike<boolean>

    The promise.

Abstract get

Abstract init

  • init(): PromiseLike<boolean>

Protected reset

  • reset(): PromiseLike<boolean>

Protected resetVars

  • resetVars(): void

Protected saveRevision

setBoard

Generated using TypeDoc