📄 tanstack/pacer/latest/docs/reference/interfaces/AsyncQueuerOptions
File: AsyncQueuerOptions.md | Updated: 11/15/2025
Source: https://tanstack.com/pacer/latest/docs/reference/interfaces/AsyncQueuerOptions
Search...
+ K
Auto
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide
Documentation
Framework
React
Version
Latest
Search...
+ K
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
TanStack Query Examples
Framework
React
Version
Latest
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
TanStack Query Examples
On this page
AsyncQueuerOptions
Copy Markdown
Interface: AsyncQueuerOptions<TValue>
=====================================
Defined in: async-queuer.ts:112
Type Parameters
---------------
### TValue
TValue
Properties
----------
### addItemsTo?
ts
optional addItemsTo: QueuePosition;
optional addItemsTo: QueuePosition;
Defined in: async-queuer.ts:121
Default position to add items to the queuer
ts
'back'
'back'
ts
optional asyncRetryerOptions: AsyncRetryerOptions<(item) => Promise<any>>;
optional asyncRetryerOptions: AsyncRetryerOptions<(item) => Promise<any>>;
Defined in: async-queuer.ts:116
Options for configuring the underlying async retryer
ts
optional concurrency: number | (queuer) => number;
optional concurrency: number | (queuer) => number;
Defined in: async-queuer.ts:127
Maximum number of concurrent tasks to process. Can be a number or a function that returns a number.
ts
1
1
ts
optional expirationDuration: number;
optional expirationDuration: number;
Defined in: async-queuer.ts:132
Maximum time in milliseconds that an item can stay in the queue If not provided, items will never expire
ts
optional getIsExpired: (item, addedAt) => boolean;
optional getIsExpired: (item, addedAt) => boolean;
Defined in: async-queuer.ts:137
Function to determine if an item has expired If provided, this overrides the expirationDuration behavior
TValue
number
boolean
ts
optional getItemsFrom: QueuePosition;
optional getItemsFrom: QueuePosition;
Defined in: async-queuer.ts:142
Default position to get items from during processing
ts
'front'
'front'
ts
optional getPriority: (item) => number;
optional getPriority: (item) => number;
Defined in: async-queuer.ts:148
Function to determine priority of items in the queuer Higher priority items will be processed first If not provided, will use static priority values attached to tasks
TValue
number
ts
optional initialItems: TValue[];
optional initialItems: TValue[];
Defined in: async-queuer.ts:152
Initial items to populate the queuer with
ts
optional initialState: Partial<AsyncQueuerState<TValue>>;
optional initialState: Partial<AsyncQueuerState<TValue>>;
Defined in: async-queuer.ts:156
Initial state for the async queuer
ts
optional key: string;
optional key: string;
Defined in: async-queuer.ts:161
Optional key to identify this async queuer instance. If provided, the async queuer will be identified by this key in the devtools and PacerProvider if applicable.
ts
optional maxSize: number;
optional maxSize: number;
Defined in: async-queuer.ts:165
Maximum number of items allowed in the queuer
ts
optional onError: (error, item, queuer) => void;
optional onError: (error, item, queuer) => void;
Defined in: async-queuer.ts:171
Optional error handler for when a task throws. If provided, the handler will be called with the error and queuer instance. This can be used alongside throwOnError - the handler will be called before any error is thrown.
Error
TValue
AsyncQueuer <TValue>
void
ts
optional onExpire: (item, queuer) => void;
optional onExpire: (item, queuer) => void;
Defined in: async-queuer.ts:175
Callback fired whenever an item expires in the queuer
TValue
AsyncQueuer <TValue>
void
ts
optional onItemsChange: (queuer) => void;
optional onItemsChange: (queuer) => void;
Defined in: async-queuer.ts:179
Callback fired whenever an item is added or removed from the queuer
AsyncQueuer <TValue>
void
ts
optional onReject: (item, queuer) => void;
optional onReject: (item, queuer) => void;
Defined in: async-queuer.ts:183
Callback fired whenever an item is rejected from being added to the queuer
TValue
AsyncQueuer <TValue>
void
ts
optional onSettled: (item, queuer) => void;
optional onSettled: (item, queuer) => void;
Defined in: async-queuer.ts:187
Optional callback to call when a task is settled
TValue
AsyncQueuer <TValue>
void
ts
optional onSuccess: (result, item, queuer) => void;
optional onSuccess: (result, item, queuer) => void;
Defined in: async-queuer.ts:191
Optional callback to call when a task succeeds
any
TValue
AsyncQueuer <TValue>
void
ts
optional started: boolean;
optional started: boolean;
Defined in: async-queuer.ts:195
Whether the queuer should start processing tasks immediately or not.
ts
optional throwOnError: boolean;
optional throwOnError: boolean;
Defined in: async-queuer.ts:201
Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. Can be explicitly set to override these defaults.
ts
optional wait: number | (queuer) => number;
optional wait: number | (queuer) => number;
Defined in: async-queuer.ts:207
Time in milliseconds to wait between processing items. Can be a number or a function that returns a number.
ts
0
0
