Skip to main content

Class: default

Defined in: src/lib/storage/index.ts:154

Keeps drawings in the browser's IndexedDB database (DATABASE_NAME), each under its own name: the drawing in one record, and each layer's pixels as a PNG in its own record, so saving rewrites only the layers that changed.

Example​

const canvas = new PaintCanvas({ layerStore: new IndexedDbLayerStore("my-drawing") });

Implements​

Constructors​

Constructor​

new default(name, factory?): IndexedDbLayerStore

Defined in: src/lib/storage/index.ts:163

Parameters​

name​

string

the drawing's name

factory?​

IDBFactory = indexedDB

the IndexedDB to use (the browser's by default)

Returns​

IndexedDbLayerStore

Properties​

name​

readonly name: string

Defined in: src/lib/storage/index.ts:155

The drawing's name. Windows using the same name share the drawing, so only one draws at a time.

Implementation of​

LayerStoreLike.name

Methods​

clear()​

clear(): Promise<void>

Defined in: src/lib/storage/index.ts:212

Delete the saved drawing

Returns​

Promise<void>

Implementation of​

LayerStoreLike.clear


load()​

load(): Promise<SavedDrawingWithImages | undefined>

Defined in: src/lib/storage/index.ts:168

The saved drawing, or undefined if none was saved

Returns​

Promise<SavedDrawingWithImages | undefined>

Implementation of​

LayerStoreLike.load


save()​

save(drawing, images): Promise<void>

Defined in: src/lib/storage/index.ts:190

Save the drawing and the images of the layers that changed (by layer ID). Images of layers no longer in the drawing are deleted.

Parameters​

drawing​

SavedDrawing

images​

ReadonlyMap<string, Blob>

Returns​

Promise<void>

Implementation of​

LayerStoreLike.save