TanStack
Rate Limiter API Reference

AngularAsyncRateLimiter

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:26

Extends

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

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

options

ts
options: AsyncRateLimiterOptions<TFn> & AngularAsyncRateLimiterOptions<TFn, TSelected>;

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:30


setOptions

ts
setOptions: (options) => void;

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:32

Parameters

options

Partial<AngularAsyncRateLimiterOptions<TFn, TSelected>>

Returns

void


state

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

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:40

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

Use this instead of rateLimiter.store.state


store

ts
readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:45

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.