OctaneAsyncThrottler

Defined in: async-throttler/useAsyncThrottler.ts:25

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

options: AsyncThrottlerOptions<TFn> & OctaneAsyncThrottlerOptions<TFn, TSelected>;

Defined in: async-throttler/useAsyncThrottler.ts:29

setOptions

setOptions: (options) => void;

Defined in: async-throttler/useAsyncThrottler.ts:31

Parameters

options

Partial<OctaneAsyncThrottlerOptions<TFn, TSelected>>

Returns

void

state

readonly state: Readonly<TSelected>;

Defined in: async-throttler/useAsyncThrottler.ts:37

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

Subscribe

Subscribe: OctanePacerSubscribe<AsyncThrottlerState<TFn>>;

Defined in: async-throttler/useAsyncThrottler.ts:35

Selects state in a child without subscribing the utility owner.