TanStack
Debouncer API Reference

OctaneDebouncer

Defined in: debouncer/useDebouncer.ts:25

A Debouncer with framework-reactive selected state. All core methods remain available.

Extends

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

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

options

ts
options: DebouncerOptions<TFn> & OctaneDebouncerOptions<TFn, TSelected>;

Defined in: debouncer/useDebouncer.ts:29


setOptions

ts
setOptions: (options) => void;

Defined in: debouncer/useDebouncer.ts:30

Parameters

options

Partial<OctaneDebouncerOptions<TFn, TSelected>>

Returns

void


state

ts
readonly state: Readonly<TSelected>;

Defined in: debouncer/useDebouncer.ts:34

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


Subscribe

ts
Subscribe: OctanePacerSubscribe<DebouncerState<TFn>>;

Defined in: debouncer/useDebouncer.ts:32

Selects state in a child without subscribing the utility owner.