Class RestorablePool<T>

constructor

• new RestorablePool<T extends IObservableDisposable = IObservableDisposable>(
      options: RestorablePool.IOptions,
  ): RestorablePool<T>

• Create a new restorable pool.

  Type Parameters

  • T extends IObservableDisposable = IObservableDisposable

  Parameters

  • options: RestorablePool.IOptions

    The instantiation options for a restorable pool.

  Returns RestorablePool<T>

Readonlynamespace

added

• get added(): ISignal<this, T>

• A signal emitted when an object object is added.

  Notes

  This signal will only fire when an object is added to the pool. It will not fire if an object injected into the pool.

  Returns ISignal<this, T>

current

• get current(): null | T

• The current object.

  Notes

  The restorable pool does not set current. It is intended for client use.

  If current is set to an object that does not exist in the pool, it is a no-op.

  Returns null | T
• set current(obj: null | T): void

• The current object.

  Parameters

  • obj: null | T

  Returns void

currentChanged

• get currentChanged(): ISignal<this, null | T>

• A signal emitted when the current widget changes.

  Returns ISignal<this, null | T>

isDisposed

• get isDisposed(): boolean

• Test whether the pool is disposed.

  Returns boolean

restored

• get restored(): Promise<void>

• A promise resolved when the restorable pool has been restored.

  Returns Promise<void>

size

• get size(): number

• The number of objects held by the pool.

  Returns number

updated

• get updated(): ISignal<this, T>

• A signal emitted when an object is updated.

  Returns ISignal<this, T>

add

• add(obj: T): Promise<void>

• Add a new object to the pool.

  Parameters

  • obj: T

    The object object being added.

    Notes

    The object passed into the pool is added synchronously; its existence in the pool can be checked with the has() method. The promise this method returns resolves after the object has been added and saved to an underlying restoration connector, if one is available.

  Returns Promise<void>

dispose

• dispose(): void

• Dispose of the resources held by the pool.

  Notes

  Disposing a pool does not affect the underlying data in the data connector, it simply disposes the client-side pool without making any connector calls.

  Returns void

filter

• filter(fn: (obj: T) => boolean): T[]

• Filter the objects in the pool based on a predicate.

  Parameters

  • fn: (obj: T) => boolean

    The function by which to filter.

  Returns T[]

find

• find(fn: (obj: T) => boolean): undefined | T

• Find the first object in the pool that satisfies a filter function.

  Parameters

  • fn: (obj: T) => boolean

    The filter function to call on each object.

  Returns undefined | T

forEach

• forEach(fn: (obj: T) => void): void

• Iterate through each object in the pool.

  Parameters

  • fn: (obj: T) => void

    The function to call on each object.

  Returns void

has

• has(obj: T): boolean

• Check if this pool has the specified object.

  Parameters

  • obj: T

    The object whose existence is being checked.

  Returns boolean

inject

• inject(obj: T): Promise<void>

• Inject an object into the restorable pool without the pool handling its restoration lifecycle.

  Parameters

  • obj: T

    The object to inject into the pool.

  Returns Promise<void>

restore

• restore(options: IRestorable.IOptions<T>): Promise<any>

• Restore the objects in this pool's namespace.

  Parameters

  • options: IRestorable.IOptions<T>

    The configuration options that describe restoration.

  Returns Promise<any>

  A promise that resolves when restoration has completed.

  Notes

  This function should almost never be invoked by client code. Its primary use case is to be invoked by a layout restorer plugin that handles multiple restorable pools and, when ready, asks them each to restore their respective objects.

save

• save(obj: T): Promise<void>

• Save the restore data for a given object.

  Parameters

  • obj: T

    The object being saved.

  Returns Promise<void>