The type of object being tracked.
Create a new restorable pool.
The instantiation options for a restorable pool.
Clean up after disposed objects.
A namespace for all tracked objects.
A signal emitted when an object object is added.
This signal will only fire when an object is added to the pool. It will not fire if an object injected into the pool.
The current object.
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.
The current object.
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.
A signal emitted when the current widget changes.
Test whether the pool is disposed.
A promise resolved when the restorable pool has been restored.
The number of objects held by the pool.
A signal emitted when an object is updated.
Add a new object to the pool.
The object object being added.
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.
Dispose of the resources held by the pool.
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.
Filter the objects in the pool based on a predicate.
The function by which to filter.
Find the first object in the pool that satisfies a filter function.
Iterate through each object in the pool.
The function to call on each object.
Check if this pool has the specified object.
The object whose existence is being checked.
Inject an object into the restorable pool without the pool handling its restoration lifecycle.
The object to inject into the pool.
Restore the objects in this pool's namespace.
The configuration options that describe restoration.
A promise that resolves when restoration has completed.
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 the restore data for a given object.
The object being saved.
Generated using TypeDoc
An object pool that supports restoration.