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

Effect.md

37 lines808 Bytes

1---
2id: Effect
3title: Effect
4---
5​
6Defined in: [packages/db/src/query/effect.ts:148](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L148)
7​
8Handle returned by createEffect
9​
10## Properties
11​
12### dispose()
13​
14```ts
15dispose: () => Promise<void>;
16```
17​
18Defined in: [packages/db/src/query/effect.ts:153](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L153)
19​
20Dispose the effect and await in-flight handlers. Calls during one cleanup
21attempt, including calls from abort/release callbacks, share its outcome.
22​
23#### Returns
24​
25`Promise`\<`void`\>
26​
27***
28​
29### disposed
30​
31```ts
32readonly disposed: boolean;
33```
34​
35Defined in: [packages/db/src/query/effect.ts:155](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L155)
36​
37Whether this effect has been disposed