Documentation / zerotal / queue / QueueManager

Class: QueueManager

Defined in: packages/queue/src/QueueManager.ts:87

Constructors

Constructor

new QueueManager(driver): QueueManager

Defined in: packages/queue/src/QueueManager.ts:94

Parameters

driver

QueueDriver

Returns

QueueManager

Accessors

isShuttingDown

Get Signature

get isShuttingDown(): boolean

Defined in: packages/queue/src/QueueManager.ts:211

Returns

boolean

activeJobCount

Get Signature

get activeJobCount(): number

Defined in: packages/queue/src/QueueManager.ts:214

Returns

number

Methods

setWorkerPool()

setWorkerPool(pool): void

Defined in: packages/queue/src/QueueManager.ts:98

Parameters

pool

JobExecutor

Returns

void

dispatch()

dispatch(job): Promise<void>

Defined in: packages/queue/src/QueueManager.ts:104

Parameters

job

Job

Returns

Promise<void>

dispatchBatch()

dispatchBatch(pending): Promise<Batch>

Defined in: packages/queue/src/QueueManager.ts:137

Parameters

pending

PendingBatch

Returns

Promise<Batch>

processNext()

processNext(queue?): Promise<boolean>

Defined in: packages/queue/src/QueueManager.ts:165

Parameters

queue?

string = "default"

Returns

Promise<boolean>

drain()

drain(): Promise<void>

Defined in: packages/queue/src/QueueManager.ts:218

Returns

Promise<void>

size()

size(queue?): Promise<number>

Defined in: packages/queue/src/QueueManager.ts:227

Parameters

queue?

string = "default"

Returns

Promise<number>

pending()

pending(queue?, limit?, offset?): Promise<JobRecord[]>

Defined in: packages/queue/src/QueueManager.ts:234

Pending (not-yet-processed) jobs, newest queues first.

Parameters

queue?

string

limit?

number = 50

offset?

number = 0

Returns

Promise<JobRecord[]>

queues()

queues(): Promise<object[]>

Defined in: packages/queue/src/QueueManager.ts:239

Distinct queue names with their pending depth.

Returns

Promise<object[]>

failed()

failed(queue?): Promise<FailedRecord[]>

Defined in: packages/queue/src/QueueManager.ts:244

Failed jobs, optionally for a single queue.

Parameters

queue?

string

Returns

Promise<FailedRecord[]>

retryFailed()

retryFailed(id): Promise<boolean>

Defined in: packages/queue/src/QueueManager.ts:249

Re-dispatch a failed job and remove it from the failed list.

Parameters

id

number

Returns

Promise<boolean>

forgetFailed()

forgetFailed(id): Promise<void>

Defined in: packages/queue/src/QueueManager.ts:267

Forget a single failed job.

Parameters

id

number

Returns

Promise<void>

clearFailed()

clearFailed(queue?): Promise<void>

Defined in: packages/queue/src/QueueManager.ts:272

Clear failed jobs, optionally for a single queue.

Parameters

queue?

string

Returns

Promise<void>

stats()

stats(): QueueStats

Defined in: packages/queue/src/QueueManager.ts:277

In-process throughput counters.

Returns

QueueStats

flush()

flush(): Promise<void>

Defined in: packages/queue/src/QueueManager.ts:281

Returns

Promise<void>