OctaneBatcher

Defined in: batcher/useBatcher.ts:21

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

Extends#

• Omit<Batcher<TValue>, "options" | "setOptions">

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Properties#

options#

options: Omit<Required<BatcherOptions<TValue>>, "initialState" | "key" | "onItemsChange" | "onExecute"> & Partial<Pick<Required<BatcherOptions<TValue>>, "initialState" | "key" | "onItemsChange" | "onExecute">> & OctaneBatcherOptions<TValue, TSelected>;

Defined in: batcher/useBatcher.ts:25

setOptions#

setOptions: (options) => void;

Defined in: batcher/useBatcher.ts:26

Parameters#

options#

Partial<OctaneBatcherOptions<TValue, TSelected>>

Returns#

void

state#

readonly state: Readonly<TSelected>;

Defined in: batcher/useBatcher.ts:32

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

Subscribe#

Subscribe: OctanePacerSubscribe<BatcherState<TValue>>;

Defined in: batcher/useBatcher.ts:30

Selects state in a child without subscribing the utility owner.