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

AngularRateLimiterOptions.md

41 lines979 Bytes

1---
2id: AngularRateLimiterOptions
3title: AngularRateLimiterOptions
4---
5​
6Defined in: [packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts:31](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L31)
7​
8Options for [injectRateLimiter](../functions/injectRateLimiter.md), including core configuration and Angular cleanup.
9​
10## Extends
11​
12- `RateLimiterOptions`\<`TFn`\>
13​
14## Type Parameters
15​
16### TFn
17​
18`TFn` *extends* `AnyFunction`
19​
20## Properties
21​
22### onUnmount?
23​
24```ts
25optional onUnmount?: (core) => void;
26```
27​
28Defined in: [packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L38)
29​
30Called when the owning injection context is destroyed. Receives the core instance.
31There is no default cleanup; use this callback for custom teardown.
32​
33#### Parameters
34​
35##### core
36​
37`RateLimiter`\<`TFn`\>
38​
39#### Returns
40​
41`void`