TanStack
Throttler API Reference

AngularAsyncThrottler

Defined in: async-throttler/injectAsyncThrottler.ts:27

Extends

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

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

options

ts
options: AsyncThrottlerOptions<TFn> & AngularAsyncThrottlerOptions<TFn, TSelected>;

Defined in: async-throttler/injectAsyncThrottler.ts:31


setOptions

ts
setOptions: (options) => void;

Defined in: async-throttler/injectAsyncThrottler.ts:33

Parameters

options

Partial<AngularAsyncThrottlerOptions<TFn, TSelected>>

Returns

void


state

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

Defined in: async-throttler/injectAsyncThrottler.ts:41

Reactive state signal that will be updated when the async throttler state changes

Use this instead of throttler.store.state


store

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

Defined in: async-throttler/injectAsyncThrottler.ts:46

Deprecated

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