Skip to main content

Interface: DocumentStoreLike

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

Where whole documents are kept away from the browser, e.g. a user's account online (see RemoteDocumentAutosave). Saving can be slow, so it's done less often than keeping the drawing in the browser.

Extended by​

Properties​

label?​

readonly optional label?: string

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

Names the store for the user, e.g. "Bluesky" (shown while saving)

Methods​

load()​

load(id): Promise<DrawingDocument | undefined>

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

A saved document by ID, or undefined if there's none

Parameters​

id​

string

Returns​

Promise<DrawingDocument | undefined>


save()​

save(document, onProgress?): Promise<void>

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

Save a document, replacing the one with the same ID. Call onProgress with how much is done (0 to 1), if known.

Parameters​

document​

DrawingDocument

onProgress?​

(done) => void

Returns​

Promise<void>