queue
Function: queue()
ts
function queue<TValue>(options): (item, position, runOnUpdate) => boolean
function queue<TValue>(options): (item, position, runOnUpdate) => boolean
Defined in: queuer.ts:408
Creates a queue that processes items in a queuer immediately upon addition. Items are processed sequentially in FIFO order by default.
This is a simplified wrapper around the Queuer class that only exposes the addItem method. This queue is always running and will process items as they are added. For more control over queuer processing, use the Queuer class directly which provides methods like start, stop, reset, and more.
Type Parameters
• TValue
Parameters
options
QueuerOptions<TValue> = {}
Returns
Function
Adds an item to the queuer and starts processing if not already running
Parameters
item
TValue
position
QueuePosition = ...
runOnUpdate
boolean = true
Returns
boolean
true if item was added, false if queuer is full
Example
ts
// Basic sequential processing
const processItems = queuer<number>({
wait: 1000,
onItemsChange: (queuer) => console.log(queuer.getAllItems())
})
processItems(1) // Logs: 1
processItems(2) // Logs: 2 after 1 completes
// Priority queuer
const processPriority = queuer<number>({
process: async (n) => console.log(n),
getPriority: n => n // Higher numbers processed first
})
processPriority(1)
processPriority(3) // Processed before 1
// Basic sequential processing
const processItems = queuer<number>({
wait: 1000,
onItemsChange: (queuer) => console.log(queuer.getAllItems())
})
processItems(1) // Logs: 1
processItems(2) // Logs: 2 after 1 completes
// Priority queuer
const processPriority = queuer<number>({
process: async (n) => console.log(n),
getPriority: n => n // Higher numbers processed first
})
processPriority(1)
processPriority(3) // Processed before 1
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.