TanStack
Batcher API Reference

VueBatcher

Defined in: batcher/useBatcher.ts:19

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

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

Defined in: batcher/useBatcher.ts:23


setOptions

ts
setOptions: (options) => void;

Defined in: batcher/useBatcher.ts:24

Parameters

options

Partial<VueBatcherOptions<TValue, TSelected>>

Returns

void


state

ts
readonly state: Readonly<ShallowRef<TSelected>>;

Defined in: batcher/useBatcher.ts:28

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


Subscribe

ts
Subscribe: VuePacerSubscribe<BatcherState<TValue>>;

Defined in: batcher/useBatcher.ts:26

Subscribes a scoped slot to state without re-rendering the utility owner.