Interface Autosave

interface Autosave {
    state: AutosaveState;
    backupNow(): Promise<Backup | null>;
    clearDraft(): Promise<void>;
    destroy(): void;
    flush(): Promise<void>;
    listBackups(): Promise<readonly Backup[]>;
    loadBackup(id: string): Promise<SavedDocument | null>;
    loadDraft(): Promise<SavedDocument | null>;
    restoreBackup(id: string): Promise<boolean>;
}

Index

Properties

Methods

backupNow clearDraft destroy flush listBackups loadBackup loadDraft restoreBackup

Properties

`Readonly`state

state: AutosaveState

Methods

backupNow

backupNow(): Promise<Backup | null>
Take a backup of the current document now.

Returns Promise<Backup | null>
- Defined in persistence.ts:116

clearDraft

clearDraft(): Promise<void>
Returns Promise<void>
- Defined in persistence.ts:110

destroy

destroy(): void
Returns void
- Defined in persistence.ts:117

flush

flush(): Promise<void>
Write now, regardless of the debounce.

Returns Promise<void>
- Defined in persistence.ts:108

listBackups

listBackups(): Promise<readonly Backup[]>
Returns Promise<readonly Backup[]>
- Defined in persistence.ts:111

loadBackup

loadBackup(id: string): Promise<SavedDocument | null>
Parameters
- id: string
Returns Promise<SavedDocument | null>
- Defined in persistence.ts:112

loadDraft

loadDraft(): Promise<SavedDocument | null>
Returns Promise<SavedDocument | null>
- Defined in persistence.ts:109

restoreBackup

restoreBackup(id: string): Promise<boolean>
Restore a backup into the editor as an undoable step.
Parameters
- id: string
Returns Promise<boolean>
- Defined in persistence.ts:114