QueuerOptions | TanStack Pacer Français

Options for configuring a Queuer instance.

These options control queue behavior, item expiration, callbacks, and more.

Type Parameters

TValue

TValue

Properties

addItemsTo?

optional addItemsTo?: QueuePosition;

Defined in: queuer.ts:88

Default position to add items to the queuer

Default

'back'

expirationDuration?

optional expirationDuration?: number;

Defined in: queuer.ts:93

Maximum time in milliseconds that an item can stay in the queue If not provided, items will never expire

getIsExpired?

optional getIsExpired?: (item, addedAt) => boolean;

Defined in: queuer.ts:98

Function to determine if an item has expired If provided, this overrides the expirationDuration behavior

Parameters

item

TValue

addedAt

number

Returns

boolean

getItemsFrom?

optional getItemsFrom?: QueuePosition;

Defined in: queuer.ts:103

Default position to get items from during processing

Default

'front'

getPriority?

optional getPriority?: (item) => number;

Defined in: queuer.ts:108

Function to determine priority of items in the queuer Higher priority items will be processed first

Parameters

item

TValue

Returns

number

initialItems?

optional initialItems?: TValue[];

Defined in: queuer.ts:112

Initial items to populate the queuer with

initialState?

optional initialState?: Partial<QueuerState<TValue>>;

Defined in: queuer.ts:116

Initial state for the queuer

key?

optional key?: string;

Defined in: queuer.ts:121

Optional key to identify this queuer instance. If provided, the queuer will be identified by this key in the devtools and PacerProvider if applicable.

maxSize?

optional maxSize?: number;

Defined in: queuer.ts:125

Maximum number of items allowed in the queuer

onExecute?

optional onExecute?: (item, queuer) => void;

Defined in: queuer.ts:129

Callback fired whenever an item is removed from the queuer

Parameters

item

TValue

queuer

Queuer<TValue>

Returns

void

onExpire?

optional onExpire?: (item, queuer) => void;

Defined in: queuer.ts:133

Callback fired whenever an item expires in the queuer

Parameters

item

TValue

queuer

Queuer<TValue>

Returns

void

onItemsChange?

optional onItemsChange?: (queuer) => void;

Defined in: queuer.ts:137

Callback fired whenever an item is added or removed from the queuer

Parameters

queuer

Queuer<TValue>

Returns

void

onReject?

optional onReject?: (item, queuer) => void;

Defined in: queuer.ts:141

Callback fired whenever an item is rejected from being added to the queuer

Parameters

item

TValue

queuer

Queuer<TValue>

Returns

void

started?

optional started?: boolean;

Defined in: queuer.ts:145

Whether the queuer should start processing tasks immediately

wait?

optional wait?: number | ((queuer) => number);

Defined in: queuer.ts:151

Time in milliseconds to wait between processing items. Can be a number or a function that returns a number.