@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / InstantiatedQueue
Interface: InstantiatedQueue
Object that abstracts a concrete connection to a queue instance.
Extends
Properties
addTask()
addTask: (
payload,taskId?) =>Promise<object>
Adds a specific payload to the queue and returns a unique jobId
Parameters
• payload: TaskPayload
• taskId?: string
Returns
Promise<object>
taskId
taskId:
string
Defined in
packages/sequencer/src/worker/queue/TaskQueue.ts:28
close()
close: () =>
Promise<void>
Returns
Promise<void>
Inherited from
Defined in
packages/sequencer/src/sequencer/builder/Closeable.ts:4
drain()
drain: () =>
Promise<void>
Drains the queue to clear stale tasks
Returns
Promise<void>
Defined in
packages/sequencer/src/worker/queue/TaskQueue.ts:45
name
name:
string
Defined in
packages/sequencer/src/worker/queue/TaskQueue.ts:23
offCompleted()
offCompleted: (
listenerId) =>void
Parameters
• listenerId: number
Returns
void
Defined in
packages/sequencer/src/worker/queue/TaskQueue.ts:40
onCompleted()
onCompleted: (
listener) =>Promise<number>
Registers a listener for the completion of jobs
Parameters
• listener
Returns
Promise<number>