AngularRateLimiter

Defined in: rate-limiter/injectRateLimiter.ts:25

Extends#

• Omit<RateLimiter<TFn>, "store" | "options" | "setOptions">

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Properties#

options#

options: RateLimiterOptions<TFn> & AngularRateLimiterOptions<TFn, TSelected>;

Defined in: rate-limiter/injectRateLimiter.ts:29

setOptions#

setOptions: (options) => void;

Defined in: rate-limiter/injectRateLimiter.ts:31

Parameters#

options#

Partial<AngularRateLimiterOptions<TFn, TSelected>>

Returns#

void

state#

readonly state: Signal<Readonly<TSelected>>;

Defined in: rate-limiter/injectRateLimiter.ts:39

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

Use this instead of rateLimiter.store.state

store#

readonly store: Store<Readonly<RateLimiterState>>;

Defined in: rate-limiter/injectRateLimiter.ts:44

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.