Interface DrawingDocumentStore

Where the documents live, one per instrument key. The host's choice: memoryDrawingStore (the default), webStorageDrawingStore over a web storage the host hands it, or its own. Synchronous; a throw from any method, or set returning false, is a failure the helper reports.

interface DrawingDocumentStore {
    get(key: string): unknown;
    remove(key: string): void;
    set(key: string, document: DrawingsDocument): boolean | void;
}

Index

Methods

Methods

get

get(key: string): unknown
The document stored under key, or null (or undefined) when there is none.
Parameters
- key: string
Returns unknown
- Defined in src/draw/instrument-drawings.ts:70

remove

remove(key: string): void
Forget whatever is stored under key.
Parameters
- key: string
Returns void
- Defined in src/draw/instrument-drawings.ts:74

set

set(key: string, document: DrawingsDocument): boolean | void
Store document under key. False, or a throw, when the write did not land.
Parameters
- key: string
- document: DrawingsDocument
Returns boolean | void
- Defined in src/draw/instrument-drawings.ts:72