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

AlpineAsyncRateLimiterOptions.md

45 lines949 Bytes

1---
2id: AlpineAsyncRateLimiterOptions
3title: AlpineAsyncRateLimiterOptions
4---
5​
6Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L13)
7​
8Options for createAsyncRateLimiter, including owner cleanup.
9​
10## Extends
11​
12- `AsyncRateLimiterOptions`\<`TFn`\>
13​
14## Type Parameters
15​
16### TFn
17​
18`TFn` *extends* `AnyAsyncFunction`
19​
20### TSelected
21​
22`TSelected` = \{
23\}
24​
25## Properties
26​
27### onUnmount?
28​
29```ts
30optional onUnmount?: (instance) => void;
31```
32​
33Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:18](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L18)
34​
35Replaces default cleanup. Use this to flush, cancel, or stop pending work.
36​
37#### Parameters
38​
39##### instance
40​
41[`AlpineAsyncRateLimiter`](AlpineAsyncRateLimiter.md)\<`TFn`, `TSelected`\>
42​
43#### Returns
44​
45`void`