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

ThrottlerState.md

96 lines1.9 KB

1---
2id: ThrottlerState
3title: ThrottlerState
4---
5​
6Defined in: [throttler.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L6)
7​
8## Type Parameters
9​
10### TFn
11​
12`TFn` *extends* [`AnyFunction`](../type-aliases/AnyFunction.md)
13​
14## Properties
15​
16### executionCount
17​
18```ts
19executionCount: number;
20```
21​
22Defined in: [throttler.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L10)
23​
24Number of function executions that have been completed
25​
26***
27​
28### isPending
29​
30```ts
31isPending: boolean;
32```
33​
34Defined in: [throttler.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L14)
35​
36Whether the throttler is waiting for the timeout to trigger execution
37​
38***
39​
40### lastArgs
41​
42```ts
43lastArgs: Parameters<TFn> | undefined;
44```
45​
46Defined in: [throttler.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L18)
47​
48The arguments from the most recent call to maybeExecute
49​
50***
51​
52### lastExecutionTime
53​
54```ts
55lastExecutionTime: number;
56```
57​
58Defined in: [throttler.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L22)
59​
60Timestamp of the last function execution in milliseconds
61​
62***
63​
64### maybeExecuteCount
65​
66```ts
67maybeExecuteCount: number;
68```
69​
70Defined in: [throttler.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L26)
71​
72Number of times maybeExecute has been called (for reduction calculations)
73​
74***
75​
76### nextExecutionTime
77​
78```ts
79nextExecutionTime: number | undefined;
80```
81​
82Defined in: [throttler.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L30)
83​
84Timestamp when the next execution can occur in milliseconds
85​
86***
87​
88### status
89​
90```ts
91status: "disabled" | "idle" | "pending";
92```
93​
94Defined in: [throttler.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L34)
95​
96Current execution status - 'idle' when not active, 'pending' when waiting for timeout