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

createEffect.md

49 lines1.0 KB

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