OctaneAsyncBatcher

Defined in: async-batcher/useAsyncBatcher.ts:24

An AsyncBatcher with framework-reactive selected state. All core methods remain available.

Extends#

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

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Properties#

options#

options: Omit<Required<AsyncBatcherOptions<TValue>>,
  | "initialState"
  | "key"
  | "onError"
  | "onSettled"
  | "onSuccess"
  | "onItemsChange"> & Partial<Pick<Required<AsyncBatcherOptions<TValue>>,
  | "initialState"
  | "key"
  | "onError"
  | "onSettled"
  | "onSuccess"
| "onItemsChange">> & OctaneAsyncBatcherOptions<TValue, TSelected>;

Defined in: async-batcher/useAsyncBatcher.ts:28

setOptions#

setOptions: (options) => void;

Defined in: async-batcher/useAsyncBatcher.ts:30

Parameters#

options#

Partial<OctaneAsyncBatcherOptions<TValue, TSelected>>

Returns#

void

state#

readonly state: Readonly<TSelected>;

Defined in: async-batcher/useAsyncBatcher.ts:36

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

Subscribe#

Subscribe: OctanePacerSubscribe<AsyncBatcherState<TValue>>;

Defined in: async-batcher/useAsyncBatcher.ts:34

Selects state in a child without subscribing the utility owner.