EffectConfig

Defined in: packages/db/src/query/effect.ts:113

Effect configuration

Type Parameters#

TRow#

TRow extends object = Record<string, unknown>

TKey#

TKey extends string | number = string | number

Properties#

id?#

optional id: string;

Defined in: packages/db/src/query/effect.ts:118

Optional ID for debugging/tracing

onBatch?#

optional onBatch: EffectBatchHandler<TRow, TKey>;

Defined in: packages/db/src/query/effect.ts:133

Called once per graph run with all delta events from that batch

onEnter?#

optional onEnter: EffectEventHandler<TRow, TKey>;

Defined in: packages/db/src/query/effect.ts:124

Called once for each row entering the query result

onError()?#

optional onError: (error, event) => void;

Defined in: packages/db/src/query/effect.ts:136

Error handler for exceptions thrown by effect callbacks

Parameters#

error#

Error

event#

DeltaEvent<TRow, TKey>

Returns#

void

onExit?#

optional onExit: EffectEventHandler<TRow, TKey>;

Defined in: packages/db/src/query/effect.ts:130

Called once for each row exiting the query result

onHealthChange()?#

optional onHealthChange: (health) => void;

Defined in: packages/db/src/query/effect.ts:154

Called after the effect's initial-query readiness whenever its health tree changes. A sync problem after initial-query readiness does not dispose the effect; read the health tree to decide what to do.

Parameters#

health#

HealthNode

Returns#

void

onSourceError()?#

optional onSourceError: (error) => void;

Defined in: packages/db/src/query/effect.ts:147

Called when a source crashes, fails its first load before the effect's initial-query readiness, or is cleaned up while the effect reads it, and when a subset load the effect requests from a source, or its release, fails, before or after that readiness. A cascade cleanup that ends the effect does not call it. The effect is automatically disposed after this callback fires. If not provided, the error is logged to console.error.

Parameters#

error#

Error

Returns#

void

onUpdate?#

optional onUpdate: EffectEventHandler<TRow, TKey>;

Defined in: packages/db/src/query/effect.ts:127

Called once for each row updating within the query result

query#

query: EffectQueryInput<any>;

Defined in: packages/db/src/query/effect.ts:121

Query to watch for deltas

skipInitial?#

optional skipInitial: boolean;

Defined in: packages/db/src/query/effect.ts:161

Skip deltas during initial collection load. Defaults to false (process all deltas including initial sync). Set to true for effects that should only process new changes.