Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<T>

The state restoration configuration options.

Type parameters

  • T: IObservableDisposable

    The type of object held by the restorable collection.

Hierarchy

Index

Properties

Properties

Optional args

args: (obj: T) => ReadonlyPartialJSONObject

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

Type declaration

    • (obj: T): ReadonlyPartialJSONObject

    • Parameters

      • obj: T

      Returns ReadonlyPartialJSONObject

command

command: string

The command to execute when restoring instances.

name

name: (obj: T) => string

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

Type declaration

    • (obj: T): string

    • Parameters

      • obj: T

      Returns string

Optional when

when: Promise<any> | Array<Promise<any>>

The point after which it is safe to restore state.

Generated using TypeDoc