Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRestorer<T, U, V>

An interface for a state restorer.

Type parameters

  • T: IRestorable<U> = IRestorable<IObservableDisposable>

    The restorable collection's type.

  • U: IObservableDisposable = IObservableDisposable

    The type of object held by the restorable collection.

  • V = any

    The restored promise resolution type. Defaults to any.

Hierarchy

Index

Properties

Methods

Properties

Readonly restored

restored: Promise<V>

A promise that settles when the collection has been restored.

Methods

restore

  • restore(restorable: T, options: IOptions<U>): Promise<V>
  • Restore the objects in a given restorable collection.

    Parameters

    • restorable: T

      The restorable collection being restored.

    • options: IOptions<U>

      The configuration options that describe restoration.

    Returns Promise<V>

    A promise that settles when restored with any results.

Generated using TypeDoc