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

PreactRateLimiterOptions.md

44 lines910 Bytes

1---
2id: PreactRateLimiterOptions
3title: PreactRateLimiterOptions
4---
5​
6Defined in: [rate-limiter/useRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L13)
7​
8## Extends
9​
10- `RateLimiterOptions`\<`TFn`\>
11​
12## Type Parameters
13​
14### TFn
15​
16`TFn` *extends* `AnyFunction`
17​
18### TSelected
19​
20`TSelected` = \{
21\}
22​
23## Properties
24​
25### onUnmount?
26​
27```ts
28optional onUnmount?: (rateLimiter) => void;
29```
30​
31Defined in: [rate-limiter/useRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L21)
32​
33Optional callback invoked when the component unmounts. Receives the rate limiter instance.
34When provided, replaces the default cleanup; use it to call reset(), add logging, etc.
35​
36#### Parameters
37​
38##### rateLimiter
39​
40[`PreactRateLimiter`](PreactRateLimiter.md)\<`TFn`, `TSelected`\>
41​
42#### Returns
43​
44`void`