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

AsyncThrottlerState.md

144 lines3.1 KB

1---
2id: AsyncThrottlerState
3title: AsyncThrottlerState
4---
5​
6Defined in: [async-throttler.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L8)
7​
8## Type Parameters
9​
10### TFn
11​
12`TFn` *extends* [`AnyAsyncFunction`](../type-aliases/AnyAsyncFunction.md)
13​
14## Properties
15​
16### errorCount
17​
18```ts
19errorCount: number;
20```
21​
22Defined in: [async-throttler.ts:12](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L12)
23​
24Number of function executions that have resulted in errors
25​
26***
27​
28### isExecuting
29​
30```ts
31isExecuting: boolean;
32```
33​
34Defined in: [async-throttler.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L16)
35​
36Whether the throttled function is currently executing asynchronously
37​
38***
39​
40### isPending
41​
42```ts
43isPending: boolean;
44```
45​
46Defined in: [async-throttler.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L20)
47​
48Whether the throttler is waiting for the timeout to trigger execution
49​
50***
51​
52### lastArgs
53​
54```ts
55lastArgs: Parameters<TFn> | undefined;
56```
57​
58Defined in: [async-throttler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L24)
59​
60The arguments from the most recent call to maybeExecute
61​
62***
63​
64### lastExecutionTime
65​
66```ts
67lastExecutionTime: number;
68```
69​
70Defined in: [async-throttler.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L28)
71​
72Timestamp of the last function execution in milliseconds
73​
74***
75​
76### lastResult
77​
78```ts
79lastResult: Awaited<ReturnType<TFn>> | undefined;
80```
81​
82Defined in: [async-throttler.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L32)
83​
84The result from the most recent successful function execution
85​
86***
87​
88### maybeExecuteCount
89​
90```ts
91maybeExecuteCount: number;
92```
93​
94Defined in: [async-throttler.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L36)
95​
96Number of times maybeExecute has been called (for reduction calculations)
97​
98***
99​
100### nextExecutionTime
101​
102```ts
103nextExecutionTime: number | undefined;
104```
105​
106Defined in: [async-throttler.ts:40](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L40)
107​
108Timestamp when the next execution can occur in milliseconds
109​
110***
111​
112### settleCount
113​
114```ts
115settleCount: number;
116```
117​
118Defined in: [async-throttler.ts:44](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L44)
119​
120Number of function executions that have completed (either successfully or with errors)
121​
122***
123​
124### status
125​
126```ts
127status: "disabled" | "idle" | "executing" | "pending" | "settled";
128```
129​
130Defined in: [async-throttler.ts:48](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L48)
131​
132Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed
133​
134***
135​
136### successCount
137​
138```ts
139successCount: number;
140```
141​
142Defined in: [async-throttler.ts:52](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L52)
143​
144Number of function executions that have completed successfully