Defined in: queuer.ts:4

Options for configuring a Queuer instance

• TValue

optional addItemsTo: QueuePosition;

optional addItemsTo: QueuePosition;

Defined in: queuer.ts:9

Default position to add items to the queuer

'back'

'back'

optional expirationDuration: number;

optional expirationDuration: number;

Defined in: queuer.ts:14

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:19

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:24

Default position to get items from during processing

'front'

'front'

optional getPriority: (item) => number;

optional getPriority: (item) => number;

Defined in: queuer.ts:29

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:33

Initial items to populate the queuer with

optional maxSize: number;

optional maxSize: number;

Defined in: queuer.ts:37

Maximum number of items allowed in the queuer

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

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

Defined in: queuer.ts:41

Callback fired whenever an item expires in the queuer

TValue

Queuer<TValue>

void

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

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

Defined in: queuer.ts:45

Callback fired whenever an item is removed from the queuer

TValue

Queuer<TValue>

void

optional onIsRunningChange: (queuer) => void;

optional onIsRunningChange: (queuer) => void;

Defined in: queuer.ts:49

Callback fired whenever the queuer's running state changes

Queuer<TValue>

void

optional onItemsChange: (queuer) => void;

optional onItemsChange: (queuer) => void;

Defined in: queuer.ts:53

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:57

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:61

Whether the queuer should start processing tasks immediately

optional wait: number;

optional wait: number;

Defined in: queuer.ts:65

Time in milliseconds to wait between processing items