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

AngularRateLimiter.md

36 lines940 Bytes

1---
2id: AngularRateLimiter
3title: AngularRateLimiter
4---
5​
6Defined in: [packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts:58](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L58)
7​
8An Angular RateLimiter ref with stable core methods and readonly selected state.
9Read `state()` to observe the selector result; without a selector it returns `{}`.
10​
11## Extends
12​
13- `Pick`\<`RateLimiter`\<`TFn`\>, `RateLimiterMethod`\>
14​
15## Type Parameters
16​
17### TFn
18​
19`TFn` *extends* `AnyFunction`
20​
21### TSelected
22​
23`TSelected` = \{
24\}
25​
26## Properties
27​
28### state
29​
30```ts
31readonly state: Signal<ReadonlySelected<TSelected>>;
32```
33​
34Defined in: [packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts:63](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L63)
35​
36The readonly selector result. Returns an empty object when no selector is supplied.