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

RateLimiterState.md

78 lines1.7 KB

1---
2id: RateLimiterState
3title: RateLimiterState
4---
5​
6Defined in: [rate-limiter.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L6)
7​
8## Properties
9​
10### executionCount
11​
12```ts
13executionCount: number;
14```
15​
16Defined in: [rate-limiter.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L10)
17​
18Number of function executions that have been completed
19​
20***
21​
22### executionTimes
23​
24```ts
25executionTimes: number[];
26```
27​
28Defined in: [rate-limiter.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L14)
29​
30Array of timestamps when executions occurred for rate limiting calculations
31​
32***
33​
34### isExceeded
35​
36```ts
37isExceeded: boolean;
38```
39​
40Defined in: [rate-limiter.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L18)
41​
42Whether the rate limiter has exceeded the limit
43​
44***
45​
46### maybeExecuteCount
47​
48```ts
49maybeExecuteCount: number;
50```
51​
52Defined in: [rate-limiter.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L22)
53​
54Number of times maybeExecute has been called (for reduction calculations)
55​
56***
57​
58### rejectionCount
59​
60```ts
61rejectionCount: number;
62```
63​
64Defined in: [rate-limiter.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L26)
65​
66Number of function executions that have been rejected due to rate limiting
67​
68***
69​
70### status
71​
72```ts
73status: "disabled" | "idle" | "exceeded";
74```
75​
76Defined in: [rate-limiter.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L30)
77​
78Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded