TanStack
Throttler API Reference

LitAsyncThrottler

Defined in: async-throttler/createAsyncThrottler.ts:23

An AsyncThrottler with framework-reactive selected state. All core methods remain available.

Extends

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

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

options

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

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


setOptions

ts
setOptions: (options) => void;

Defined in: async-throttler/createAsyncThrottler.ts:29

Parameters

options

Partial<LitAsyncThrottlerOptions<TFn, TSelected>>

Returns

void


state

ts
readonly state: Readonly<TSelected>;

Defined in: async-throttler/createAsyncThrottler.ts:35

Selected state. Pass a selector to opt in; the default selection is an empty object.


subscribe

ts
subscribe: LitPacerSubscribe<AsyncThrottlerState<TFn>>;

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

Subscribes a child owner to selected state with automatic cleanup.