OctaneThrottler

Defined in: throttler/useThrottler.ts:25

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

Extends#

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

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Properties#

options#

options: ThrottlerOptions<TFn> & OctaneThrottlerOptions<TFn, TSelected>;

Defined in: throttler/useThrottler.ts:29

setOptions#

setOptions: (options) => void;

Defined in: throttler/useThrottler.ts:30

Parameters#

options#

Partial<OctaneThrottlerOptions<TFn, TSelected>>

Returns#

void

state#

readonly state: Readonly<TSelected>;

Defined in: throttler/useThrottler.ts:34

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

Subscribe#

Subscribe: OctanePacerSubscribe<ThrottlerState<TFn>>;

Defined in: throttler/useThrottler.ts:32

Selects state in a child without subscribing the utility owner.