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

Type declaration

    • (obj: T): ReadonlyPartialJSONObject

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

      Parameters

      • obj: T

      Returns ReadonlyPartialJSONObject

command

command: string

The command to execute when restoring instances.

connector

connector: IDataConnector<ReadonlyPartialJSONValue, ReadonlyPartialJSONValue, string, string>

The data connector to fetch restore data.

name

name: (obj: T) => string

Type declaration

    • (obj: T): string

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

      Parameters

      • obj: T

      Returns string

registry

registry: CommandRegistry

The command registry which holds the restore command.

Optional when

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

The point after which it is safe to restore state.

Generated using TypeDoc