Interface IOptions<T>

The state restoration configuration options.

Typeparam

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

interface IOptions<T> {
    args?: ((obj) => ReadonlyPartialJSONObject);
    command: string;
    name: ((obj) => string);
    when?: Promise<any> | Promise<any>[];
}

Type Parameters

T extends IObservableDisposable

Hierarchy (view full)

IOptions
- IRestorable.IOptions

Index

Properties

args? command name when?

Properties

`Optional` args

args?: ((obj) => ReadonlyPartialJSONObject)

A function that returns the args needed to restore an instance.

Type declaration

- (obj): ReadonlyPartialJSONObject
- Parameters
  - obj: T
  Returns ReadonlyPartialJSONObject

command

command: string

The command to execute when restoring instances.

name

name: ((obj) => string)

A function that returns a unique persistent name for this instance.

Type declaration

- (obj): string
- Parameters
  - obj: T
  Returns string

`Optional` when

when?: Promise<any> | Promise<any>[]

The point after which it is safe to restore state.