TanStack
Throttler API Reference

SvelteAsyncThrottler

Defined in: packages/svelte-pacer/src/async-throttler/createAsyncThrottler.ts:22

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> & SvelteAsyncThrottlerOptions<TFn, TSelected>;

Defined in: packages/svelte-pacer/src/async-throttler/createAsyncThrottler.ts:26


setOptions

ts
setOptions: (options) => void;

Defined in: packages/svelte-pacer/src/async-throttler/createAsyncThrottler.ts:28

Parameters

options

Partial<SvelteAsyncThrottlerOptions<TFn, TSelected>>

Returns

void


state

ts
readonly state: Readonly<TSelected>;

Defined in: packages/svelte-pacer/src/async-throttler/createAsyncThrottler.ts:34

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


Subscribe

ts
Subscribe: SveltePacerSubscribe<AsyncThrottlerState<TFn>>;

Defined in: packages/svelte-pacer/src/async-throttler/createAsyncThrottler.ts:32

Subscribes a child snippet to state without updating the utility owner.