TanStack
Throttler API Reference

OctaneThrottlerOptions

Defined in: throttler/useThrottler.ts:16

Options for useThrottler, including owner cleanup.

Extends

  • ThrottlerOptions<TFn>

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

onUnmount?

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

Defined in: throttler/useThrottler.ts:21

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

Parameters

instance

OctaneThrottler<TFn, TSelected>

Returns

void