JobProcessor

Defined in: packages/messaging/src/queue/job.processor.ts:54

Extends

• EventEmitter

Extended by

• MessageJobProcessor

Constructors

Constructor

new JobProcessor(options, jobQueue?): JobProcessor

Defined in: packages/messaging/src/queue/job.processor.ts:64

Parameters

options

JobProcessorOptions

jobQueue?

JobQueue<any>

Returns

JobProcessor

Overrides

EventEmitter.constructor

Methods

add()

add<T>(jobType, data, options?): Promise<string>

Defined in: packages/messaging/src/queue/job.processor.ts:108

Add a job to the queue

Type Parameters

T

T

Parameters

jobType

string

data

T

options?

delay?

number

maxAttempts?

number

metadata?

Record<string, any>

priority?

number

Returns

Promise<string>

---

addListener()

addListener(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:16

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.addListener

---

cleanup()

cleanup(): Promise<number>

Defined in: packages/messaging/src/queue/job.processor.ts:192

Remove terminal jobs from queue without touching pending or processing jobs.

Returns

Promise<number>

---

emit()

emit(eventName, …args): boolean

Defined in: packages/messaging/src/shared/event-emitter.ts:44

Parameters

eventName

string

args

…unknown[]

Returns

boolean

Inherited from

EventEmitter.emit

---

getJob()

getJob(jobId): Promise<Job<any> | undefined>

Defined in: packages/messaging/src/queue/job.processor.ts:208

Get specific job by ID

Parameters

jobId

string

Returns

Promise<Job<any> | undefined>

---

getMetrics()

getMetrics(): JobProcessorMetrics

Defined in: packages/messaging/src/queue/job.processor.ts:166

Get current metrics

Returns

JobProcessorMetrics

---

getQueueStatus()

getQueueStatus(): Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>

Defined in: packages/messaging/src/queue/job.processor.ts:173

Get queue status

Returns

Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>

---

handle()

handle<T>(jobType, handler): void

Defined in: packages/messaging/src/queue/job.processor.ts:101

Register a job handler

Type Parameters

T

T

Parameters

jobType

string

handler

JobHandler<T>

Returns

void

---

off()

off(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:20

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.off

---

on()

on(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:9

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.on

---

once()

once(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:35

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.once

---

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: packages/messaging/src/shared/event-emitter.ts:57

Parameters

eventName?

string

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeJob()

removeJob(jobId): Promise<boolean>

Defined in: packages/messaging/src/queue/job.processor.ts:215

Remove job from queue

Parameters

jobId

string

Returns

Promise<boolean>

---

removeListener()

removeListener(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:31

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.removeListener

---

start()

start(): void

Defined in: packages/messaging/src/queue/job.processor.ts:134

Start processing jobs

Returns

void

---

stop()

stop(): Promise<void>

Defined in: packages/messaging/src/queue/job.processor.ts:147

Stop processing jobs

Returns

Promise<void>