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

asyncRateLimiterOptions.md

32 lines847 Bytes

1---
2id: asyncRateLimiterOptions
3title: asyncRateLimiterOptions
4---
5​
6```ts
7function asyncRateLimiterOptions<TFn, TOptions>(options): TOptions;
8```
9​
10Defined in: [async-rate-limiter.ts:148](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L148)
11​
12Utility function for sharing common `AsyncRateLimiterOptions` options between different `AsyncRateLimiter` instances.
13​
14## Type Parameters
15​
16### TFn
17​
18`TFn` *extends* [`AnyAsyncFunction`](../type-aliases/AnyAsyncFunction.md) = [`AnyAsyncFunction`](../type-aliases/AnyAsyncFunction.md)
19​
20### TOptions
21​
22`TOptions` *extends* `Partial`\<[`AsyncRateLimiterOptions`](../interfaces/AsyncRateLimiterOptions.md)\<`TFn`\>\> = `Partial`\<[`AsyncRateLimiterOptions`](../interfaces/AsyncRateLimiterOptions.md)\<`TFn`\>\>
23​
24## Parameters
25​
26### options
27​
28`TOptions`
29​
30## Returns
31​
32`TOptions`