WatchedQuery<Data, Settings, Listener>
Extends
MetaBaseObserverInterface<Listener>
Type Parameters
| Type Parameter | Default type |
|---|---|
Data | unknown |
Settings extends WatchedQueryOptions | WatchedQueryOptions |
Listener extends WatchedQueryListener<Data> | WatchedQueryListener<Data> |
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
closed | readonly | boolean | - | - |
listenerMeta | public | ListenerMetaManager<Listener> | - | MetaBaseObserverInterface.listenerMeta |
state | readonly | WatchedQueryState<Data> | Current state of the watched query. | - |
Methods
close()
close(): Promise<void>;
Close the watched query and end all subscriptions.
Returns
Promise<void>
registerListener()
registerListener(listener): () => void;
Subscribe to watched query events.
Parameters
| Parameter | Type |
|---|---|
listener | Listener |
Returns
A function to unsubscribe from the events.
() => void
Overrides
MetaBaseObserverInterface.registerListener
updateSettings()
updateSettings(options): Promise<void>;
Updates the underlying query options. This will trigger a re-evaluation of the query and update the state.
Parameters
| Parameter | Type |
|---|---|
options | Settings |
Returns
Promise<void>