Defined in: queuer.ts:83

Options for configuring a Queuer instance.

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

• TValue

optional addItemsTo: QueuePosition;

optional addItemsTo: QueuePosition;

Defined in: queuer.ts:88

Default position to add items to the queuer

'back'

'back'

optional expirationDuration: number;

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

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

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

TValue

number

boolean

optional getItemsFrom: QueuePosition;

optional getItemsFrom: QueuePosition;

Defined in: queuer.ts:103

Default position to get items from during processing

'front'

'front'

optional getPriority: (item) => number;

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

TValue

number

optional initialItems: TValue[];

optional initialItems: TValue[];

Defined in: queuer.ts:112

Initial items to populate the queuer with

optional initialState: Partial<QueuerState<TValue>>;

optional initialState: Partial<QueuerState<TValue>>;

Defined in: queuer.ts:116

Initial state for the queuer

optional key: string;

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.

optional maxSize: number;

optional maxSize: number;

Defined in: queuer.ts:125

Maximum number of items allowed in the queuer

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

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

Defined in: queuer.ts:129

Callback fired whenever an item is removed from the queuer

TValue

Queuer<TValue>

void

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

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

Defined in: queuer.ts:133

Callback fired whenever an item expires in the queuer

TValue

Queuer<TValue>

void

optional onItemsChange: (queuer) => void;

optional onItemsChange: (queuer) => void;

Defined in: queuer.ts:137

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

Queuer<TValue>

void

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

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

Defined in: queuer.ts:141

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

TValue

Queuer<TValue>

void

optional started: boolean;

optional started: boolean;

Defined in: queuer.ts:145

Whether the queuer should start processing tasks immediately

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

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.

0

0