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

rateLimiterOptions.md

32 lines768 Bytes

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