TanStack
Throttler API Reference

AlpineThrottlerOptions

Defined in: throttler/createThrottler.ts:13

Options for createThrottler, including owner cleanup.

Extends

  • ThrottlerOptions<TFn>

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

onUnmount?

ts
optional onUnmount?: (instance) => void;

Defined in: throttler/createThrottler.ts:18

Replaces default cleanup. Use this to flush, cancel, or stop pending work.

Parameters

instance

AlpineThrottler<TFn, TSelected>

Returns

void