@graphty/graphty-element / index / AutosaveApi
Interface: AutosaveApi ​
Defined in: graphty-element/src/autosave/types.ts:292
element.autosaver: the state of autosave, and what can be done with the saved entries.
Properties ​
ready ​
readonlyready:Promise<AutosaveRestored|null>
Defined in: graphty-element/src/autosave/types.ts:296
Settles once the restore at load was decided: what came back, or null.
restored ​
readonlyrestored:AutosaveRestored|null
Defined in: graphty-element/src/autosave/types.ts:298
The last restore in this element, or null.
status ​
readonlystatus:AutosaveStatus
Defined in: graphty-element/src/autosave/types.ts:294
Where autosave stands now. graphty-autosave-status fires on every change, never at connect.
Methods ​
discard() ​
discard():
Promise<void>
Defined in: graphty-element/src/autosave/types.ts:321
Delete this tab's own entry and load the page's own data again: start over.
Returns ​
Promise<void>
flush() ​
flush():
Promise<void>
Defined in: graphty-element/src/autosave/types.ts:300
Write everything now. Settles once committed, or once the write failed (read status).
Returns ​
Promise<void>
list() ​
list():
Promise<readonlyAutosaveEntry[]>
Defined in: graphty-element/src/autosave/types.ts:302
Every entry of this key, oldest first.
Returns ​
Promise<readonly AutosaveEntry[]>
remove() ​
remove(
id):Promise<void>
Defined in: graphty-element/src/autosave/types.ts:317
Delete an entry no tab is writing.
Parameters ​
id ​
string
The entry.
Returns ​
Promise<void>
Throws ​
A GraphtyError (as a rejection): E_AUTOSAVE_UNKNOWN_ENTRY or E_AUTOSAVE_ENTRY_TAKEN.
removeAll() ​
removeAll():
Promise<void>
Defined in: graphty-element/src/autosave/types.ts:319
Delete every entry of this key that no tab is writing.
Returns ​
Promise<void>
requestPersistence() ​
requestPersistence():
Promise<boolean>
Defined in: graphty-element/src/autosave/types.ts:336
Ask the browser for persistent storage now. Resolves with status.persisted.
Returns ​
Promise<boolean>
restore() ​
restore(
id,options?):Promise<ProjectOpenReport>
Defined in: graphty-element/src/autosave/types.ts:311
Open an entry into the graph, and keep writing to it. The work held now ends and stays listed.
Parameters ​
id ​
string
The entry.
options? ​
How to open it.
discard? ​
boolean
Open it over changes never saved to a file.
Returns ​
Promise<ProjectOpenReport>
Throws ​
A GraphtyError (as a rejection): E_UNSAVED_CHANGES, E_AUTOSAVE_UNKNOWN_ENTRY, E_AUTOSAVE_ENTRY_TAKEN, or E_BAD_DOCUMENT for an entry that cannot be read.
stash() ​
stash(
name,value):void
Defined in: graphty-element/src/autosave/types.ts:328
Save a small JSON value with the work, under a reverse-domain name (org.example.draft); undefined removes it. Never stash API keys or other secrets: the stash is stored unencrypted.
Parameters ​
name ​
string
The name.
value ​
unknown
The value.
Returns ​
void
stashed() ​
stashed(
name):unknown
Defined in: graphty-element/src/autosave/types.ts:334
A value saved with stash, valid once ready settled.
Parameters ​
name ​
string
The name.
Returns ​
unknown
A copy of the value, or undefined.