OnChangeQueryProcessor<Data>
Internal
Uses the PowerSync onChange event to trigger watched queries. Results are emitted on every change of the relevant tables.
Extends
AbstractQueryProcessor<Data,WatchedQuerySettings<Data>>
Type Parameters
| Type Parameter |
|---|
Data |
Constructors
new OnChangeQueryProcessor()
new OnChangeQueryProcessor<Data>(options): OnChangeQueryProcessor<Data>
Parameters
| Parameter | Type |
|---|---|
options | OnChangeQueryProcessorOptions<Data> |
Returns
OnChangeQueryProcessor<Data>
Overrides
AbstractQueryProcessor.constructor
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
state | readonly | WatchedQueryState<Data> | Current state of the watched query. | AbstractQueryProcessor.state |
Accessors
closed
Get Signature
get closed(): boolean
Returns
boolean
Inherited from
listenerMeta
Get Signature
get listenerMeta(): ListenerMetaManager<Listener>
Returns
ListenerMetaManager<Listener>
Inherited from
AbstractQueryProcessor.listenerMeta
Methods
close()
close(): Promise<void>
Close the watched query and end all subscriptions.
Returns
Promise<void>
Inherited from
dispose()
dispose(): void
Returns
void
Inherited from
AbstractQueryProcessor.dispose
iterateAsyncListeners()
iterateAsyncListeners(cb): Promise<void>
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => Promise<any> |
Returns
Promise<void>
Inherited from
AbstractQueryProcessor.iterateAsyncListeners
iterateListeners()
iterateListeners(cb): void
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => any |
Returns
void
Inherited from
AbstractQueryProcessor.iterateListeners
registerListener()
registerListener(listener): () => void
Register a listener for updates to the PowerSync client.
Parameters
| Parameter | Type |
|---|---|
listener | Partial<WatchedQueryProcessorListener<Data>> |
Returns
Function
Returns
void
Inherited from
AbstractQueryProcessor.registerListener
updateSettings()
updateSettings(settings): Promise<void>
Updates the underlying query.
Parameters
| Parameter | Type |
|---|---|
settings | WatchedQuerySettings |
Returns
Promise<void>