QueueManager
Defined in: queue/manager.ts:26
Queue Manager - handles all queue operations
Type Parameters
Section titled “Type Parameters”T extends QueueItem = QueueItem
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new QueueManager<
T>(storage,config?):QueueManager<T>
Defined in: queue/manager.ts:29
Parameters
Section titled “Parameters”storage
Section titled “storage”QueueStorage<T>
config?
Section titled “config?”QueueManagerConfig = {}
Returns
Section titled “Returns”QueueManager<T>
Methods
Section titled “Methods”add(
item):Promise<T>
Defined in: queue/manager.ts:43
Add an item to the queue
Parameters
Section titled “Parameters”Omit<T, "status" | "addedAt" | "retries"> & Partial<Pick<T, "status" | "addedAt" | "retries">>
Returns
Section titled “Returns”Promise<T>
cancel()
Section titled “cancel()”cancel(
id):Promise<T|undefined>
Defined in: queue/manager.ts:178
Cancel an item
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | undefined>
clear()
Section titled “clear()”clear():
Promise<void>
Defined in: queue/manager.ts:212
Clear all items (dangerous!)
Returns
Section titled “Returns”Promise<void>
complete()
Section titled “complete()”complete(
id):Promise<T|undefined>
Defined in: queue/manager.ts:130
Mark an item as completed and remove from queue
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | undefined>
fail()
Section titled “fail()”fail(
id,error):Promise<T|undefined>
Defined in: queue/manager.ts:151
Mark an item as failed If under max retries, requeue as pending
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<T | undefined>
get(
id):Promise<T|undefined>
Defined in: queue/manager.ts:95
Get an item by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | undefined>
isLocked()
Section titled “isLocked()”isLocked():
Promise<boolean>
Defined in: queue/manager.ts:236
Check if queue is locked
Returns
Section titled “Returns”Promise<boolean>
length()
Section titled “length()”length():
Promise<number>
Defined in: queue/manager.ts:204
Get current queue length
Returns
Section titled “Returns”Promise<number>
list()
Section titled “list()”list(
status?):Promise<T[]>
Defined in: queue/manager.ts:185
List all items (optionally filtered by status)
Parameters
Section titled “Parameters”status?
Section titled “status?”Returns
Section titled “Returns”Promise<T[]>
lock()
Section titled “lock()”lock():
Promise<boolean>
Defined in: queue/manager.ts:222
Acquire a lock for processing
Returns
Section titled “Returns”Promise<boolean>
next()
Section titled “next()”next():
Promise<T|undefined>
Defined in: queue/manager.ts:87
Get the next item to process (highest priority, oldest first)
Returns
Section titled “Returns”Promise<T | undefined>
processNext()
Section titled “processNext()”processNext<
R>(handler):Promise<{item:T;result:R; } |null>
Defined in: queue/manager.ts:244
Process the next item with a handler Automatically handles locking, status updates, and error handling
Type Parameters
Section titled “Type Parameters”R
Parameters
Section titled “Parameters”handler
Section titled “handler”(item) => Promise<R>
Returns
Section titled “Returns”Promise<{ item: T; result: R; } | null>
remove()
Section titled “remove()”remove(
id):Promise<T|undefined>
Defined in: queue/manager.ts:71
Remove an item from the queue
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | undefined>
startProcessing()
Section titled “startProcessing()”startProcessing(
id):Promise<T|undefined>
Defined in: queue/manager.ts:120
Mark an item as processing
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<T | undefined>
stats()
Section titled “stats()”stats():
Promise<QueueStats>
Defined in: queue/manager.ts:196
Get queue statistics
Returns
Section titled “Returns”Promise<QueueStats>
unlock()
Section titled “unlock()”unlock():
Promise<void>
Defined in: queue/manager.ts:229
Release the lock
Returns
Section titled “Returns”Promise<void>
update()
Section titled “update()”update(
id,updates):Promise<T|undefined>
Defined in: queue/manager.ts:103
Update an item’s properties
Parameters
Section titled “Parameters”string
updates
Section titled “updates”Partial<Omit<T, "id">>
Returns
Section titled “Returns”Promise<T | undefined>