Rate Limiter API Reference

AngularRateLimiter

Interface: AngularRateLimiter<TFn, TSelected>

Defined in: angular-pacer/src/rate-limiter/injectRateLimiter.ts:23

Extends

  • Omit<RateLimiter<TFn>, "store">

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

state

ts
readonly state: Signal<Readonly<TSelected>>;
readonly state: Signal<Readonly<TSelected>>;

Defined in: angular-pacer/src/rate-limiter/injectRateLimiter.ts:32

Reactive state signal that will be updated when the rate limiter state changes

Use this instead of rateLimiter.store.state


store

ts
readonly store: Store<Readonly<RateLimiterState>>;
readonly store: Store<Readonly<RateLimiterState>>;

Defined in: angular-pacer/src/rate-limiter/injectRateLimiter.ts:37

Deprecated

Use rateLimiter.state instead of rateLimiter.store.state if you want to read reactive state. The state on the store object is not reactive in Angular signals.