Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

createEffect.md

51 lines1.0 KB

1---
2id: createEffect
3title: createEffect
4---
5​
6# Function: createEffect()
7​
8```ts
9function createEffect<TRow, TKey>(config): Effect;
10```
11​
12Defined in: [packages/db/src/query/effect.ts:184](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L184)
13​
14Creates a reactive effect that fires handlers when rows enter, exit, or
15update within a query result. Effects process deltas only — they do not
16maintain or require the full materialised query result.
17​
18## Type Parameters
19​
20### TRow
21​
22`TRow` *extends* `object` = `Record`\<`string`, `unknown`\>
23​
24### TKey
25​
26`TKey` *extends* `string` \| `number` = `string` \| `number`
27​
28## Parameters
29​
30### config
31​
32[`EffectConfig`](../interfaces/EffectConfig.md)\<`TRow`, `TKey`\>
33​
34## Returns
35​
36[`Effect`](../interfaces/Effect.md)
37​
38## Example
39​
40```typescript
41const effect = createEffect({
42 query: (q) => q.from({ msg: messagesCollection })
43 .where(({ msg }) => eq(msg.role, 'user')),
44 onEnter: async (event) => {
45 await generateResponse(event.value)
46 },
47})
48​
49// Later: stop the effect
50await effect.dispose()
51```