TanStack
Queue API Reference

OctaneAsyncQueuer

Defined in: async-queuer/useAsyncQueuer.ts:24

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

Extends

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

Type Parameters

TValue

TValue

TSelected

TSelected = { }

Properties

options

ts
options: AsyncQueuerOptions<TValue> & OctaneAsyncQueuerOptions<TValue, TSelected>;

Defined in: async-queuer/useAsyncQueuer.ts:28


setOptions

ts
setOptions: (options) => void;

Defined in: async-queuer/useAsyncQueuer.ts:30

Parameters

options

Partial<OctaneAsyncQueuerOptions<TValue, TSelected>>

Returns

void


state

ts
readonly state: Readonly<TSelected>;

Defined in: async-queuer/useAsyncQueuer.ts:36

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


Subscribe

ts
Subscribe: OctanePacerSubscribe<AsyncQueuerState<TValue>>;

Defined in: async-queuer/useAsyncQueuer.ts:34

Selects state in a child without subscribing the utility owner.