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

AlpineRateLimiter.md

77 lines1.7 KB

1---
2id: AlpineRateLimiter
3title: AlpineRateLimiter
4---
5​
6Defined in: [rate-limiter/createRateLimiter.ts:22](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/rate-limiter/createRateLimiter.ts#L22)
7​
8A RateLimiter with framework-reactive selected state. All core methods remain available.
9​
10## Extends
11​
12- `Omit`\<`RateLimiter`\<`TFn`\>, `"options"` \| `"setOptions"`\>
13​
14## Type Parameters
15​
16### TFn
17​
18`TFn` *extends* `AnyFunction`
19​
20### TSelected
21​
22`TSelected` = \{
23\}
24​
25## Properties
26​
27### options
28​
29```ts
30options: RateLimiterOptions<TFn> & AlpineRateLimiterOptions<TFn, TSelected>;
31```
32​
33Defined in: [rate-limiter/createRateLimiter.ts:26](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/rate-limiter/createRateLimiter.ts#L26)
34​
35***
36​
37### setOptions
38​
39```ts
40setOptions: (options) => void;
41```
42​
43Defined in: [rate-limiter/createRateLimiter.ts:28](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/rate-limiter/createRateLimiter.ts#L28)
44​
45#### Parameters
46​
47##### options
48​
49`Partial`\<[`AlpineRateLimiterOptions`](AlpineRateLimiterOptions.md)\<`TFn`, `TSelected`\>\>
50​
51#### Returns
52​
53`void`
54​
55***
56​
57### state
58​
59```ts
60readonly state: Readonly<TSelected>;
61```
62​
63Defined in: [rate-limiter/createRateLimiter.ts:34](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/rate-limiter/createRateLimiter.ts#L34)
64​
65Selected state. Pass a selector to opt in; the default selection is an empty object.
66​
67***
68​
69### subscribe
70​
71```ts
72subscribe: AlpinePacerSubscribe<RateLimiterState>;
73```
74​
75Defined in: [rate-limiter/createRateLimiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/rate-limiter/createRateLimiter.ts#L32)
76​
77Subscribes a child owner to selected state with automatic cleanup.