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

Effect.md

38 lines767 Bytes

1---
2id: Effect
3title: Effect
4---
5​
6# Interface: Effect
7​
8Defined in: [packages/db/src/query/effect.ts:134](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L134)
9​
10Handle returned by createEffect
11​
12## Properties
13​
14### dispose()
15​
16```ts
17dispose: () => Promise<void>;
18```
19​
20Defined in: [packages/db/src/query/effect.ts:136](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L136)
21​
22Dispose the effect. Returns a promise that resolves when in-flight handlers complete.
23​
24#### Returns
25​
26`Promise`\<`void`\>
27​
28***
29​
30### disposed
31​
32```ts
33readonly disposed: boolean;
34```
35​
36Defined in: [packages/db/src/query/effect.ts:138](https://github.com/TanStack/db/blob/main/packages/db/src/query/effect.ts#L138)
37​
38Whether this effect has been disposed