Interface IRestorer<T, U, V>

An interface for a state restorer.

Typeparam

T - The restorable collection's type.

Typeparam

U - The type of object held by the restorable collection.

Typeparam

V - The restored promise resolution type. Defaults to any.

interface IRestorer<
    T extends IRestorable<U> = IRestorable<IObservableDisposable>,
    U extends IObservableDisposable = IObservableDisposable,
    V = any,
> {
    restored: Promise<V>;
    restore(restorable: T, options: IRestorable.IOptions<U>): Promise<V>;
}

Type Parameters

T extends IRestorable<U> = IRestorable<IObservableDisposable>
U extends IObservableDisposable = IObservableDisposable
V = any

Hierarchy (View Summary)

IRestorer
- ILayoutRestorer

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: IRestorable.IOptions<U>): Promise<V>
Restore the objects in a given restorable collection.
Parameters
- restorable: T
  The restorable collection being restored.
- options: IRestorable.IOptions<U>
  The configuration options that describe restoration.
Returns Promise<V>
A promise that settles when restored with any results.
- Defined in packages/statedb/src/interfaces.ts:184