Class Autosave

constructor

• new Autosave(
      engine: DotloomEngine,
      storage: StorageAdapter,
      options?: AutosaveOptions,
  ): Autosave

  Parameters

  • engine: DotloomEngine
  • storage: StorageAdapter
  • options: AutosaveOptions = {}

  Returns Autosave

Readonlystate

discard

• discard(): Promise<void>

  Forget the autosave (e.g. the user discarded recovery).

  Returns Promise<void>

dispose

• dispose(): void

  Returns void

flush

• flush(): Promise<void>

  Save now (serialized with other saves).

  Returns Promise<void>

markSaved

• markSaved(): Promise<void>

  Call after the user saved the document elsewhere (e.g. downloaded the file).

  Returns Promise<void>

recoverable

• recoverable(): Promise<StoredMeta | null>

  An autosave with unsaved changes from a previous session, if any.

  Returns Promise<StoredMeta | null>

restore

• restore(): Promise<unknown>

  Load the autosaved document into the engine. Returns the stored view state.

  Returns Promise<unknown>

setName

• setName(name: string): void

  Parameters

  • name: string

  Returns void

start

• start(): void

  Start watching commits.

  Returns void