Skip to content

@graphty/graphty-element / extend / AutosaveStore

Interface: AutosaveStore ​

Defined in: graphty-element/src/autosave/types.ts:67

A backend for autosave: the built-in IndexedDB store, memoryAutosaveStore(), or a custom one.

Methods ​

close()? ​

optional close(): Promise<void>

Defined in: graphty-element/src/autosave/types.ts:83

Closes any connection once the work in flight has finished. The next call opens it again. Optional: a store without a connection need not implement it.

Returns ​

Promise<void>


commit() ​

commit(writes, options?): Promise<void>

Defined in: graphty-element/src/autosave/types.ts:76

Atomic: every write commits, or none does. Rejects with AutosaveConflict when any entry's stored gen differs from its expectedGen. Assigns each meta's seq inside the commit.

Parameters ​

writes ​

readonly AutosaveWrite[]

options? ​

AutosaveCommitOptions

Returns ​

Promise<void>


list() ​

list(key): Promise<readonly AutosaveEntryMeta[]>

Defined in: graphty-element/src/autosave/types.ts:69

Every entry of key, oldest seq first.

Parameters ​

key ​

string

Returns ​

Promise<readonly AutosaveEntryMeta[]>


read() ​

read(id): Promise<{ meta: AutosaveEntryMeta; parts: AutosaveParts; } | undefined>

Defined in: graphty-element/src/autosave/types.ts:71

One entry with all its parts, or undefined when there is none.

Parameters ​

id ​

string

Returns ​

Promise<{ meta: AutosaveEntryMeta; parts: AutosaveParts; } | undefined>


remove() ​

remove(id): Promise<void>

Defined in: graphty-element/src/autosave/types.ts:78

Deletes an entry and all its parts. Removing a missing entry does nothing.

Parameters ​

id ​

string

Returns ​

Promise<void>