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

EffectContext.md

34 lines694 Bytes

1---
2id: EffectContext
3title: EffectContext
4---
5​
6# Interface: EffectContext
7​
8Defined in: [packages/db/src/query/effect.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L67)
9​
10Context passed to effect handlers
11​
12## Properties
13​
14### effectId
15​
16```ts
17effectId: string;
18```
19​
20Defined in: [packages/db/src/query/effect.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L69)
21​
22ID of this effect (auto-generated if not provided)
23​
24***
25​
26### signal
27​
28```ts
29signal: AbortSignal;
30```
31​
32Defined in: [packages/db/src/query/effect.ts:71](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L71)
33​
34Aborted when effect.dispose() is called