JobProcessor
Defined in: packages/messaging/src/queue/job.processor.ts:53
Extends
Section titled “Extends”EventEmitter
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JobProcessor(
options,jobQueue?):JobProcessor
Defined in: packages/messaging/src/queue/job.processor.ts:63
Parameters
Section titled “Parameters”options
Section titled “options”jobQueue?
Section titled “jobQueue?”JobQueue<any>
Returns
Section titled “Returns”JobProcessor
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”add<
T>(jobType,data,options?):Promise<string>
Defined in: packages/messaging/src/queue/job.processor.ts:107
Add a job to the queue
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”jobType
Section titled “jobType”string
T
options?
Section titled “options?”delay?
Section titled “delay?”number
maxAttempts?
Section titled “maxAttempts?”number
metadata?
Section titled “metadata?”Record<string, any>
priority?
Section titled “priority?”number
Returns
Section titled “Returns”Promise<string>
addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cleanup()
Section titled “cleanup()”cleanup():
Promise<number>
Defined in: packages/messaging/src/queue/job.processor.ts:191
Remove completed jobs from queue
Returns
Section titled “Returns”Promise<number>
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/messaging/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
getJob()
Section titled “getJob()”getJob(
jobId):Promise<Job<any> |undefined>
Defined in: packages/messaging/src/queue/job.processor.ts:202
Get specific job by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<any> | undefined>
getMetrics()
Section titled “getMetrics()”getMetrics():
JobProcessorMetrics
Defined in: packages/messaging/src/queue/job.processor.ts:165
Get current metrics
Returns
Section titled “Returns”getQueueStatus()
Section titled “getQueueStatus()”getQueueStatus():
Promise<{failed:number;pending:number;processing:number;totalProcessed:number; }>
Defined in: packages/messaging/src/queue/job.processor.ts:172
Get queue status
Returns
Section titled “Returns”Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>
handle()
Section titled “handle()”handle<
T>(jobType,handler):void
Defined in: packages/messaging/src/queue/job.processor.ts:100
Register a job handler
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”jobType
Section titled “jobType”string
handler
Section titled “handler”JobHandler<T>
Returns
Section titled “Returns”void
off(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/messaging/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeJob()
Section titled “removeJob()”removeJob(
jobId):Promise<boolean>
Defined in: packages/messaging/src/queue/job.processor.ts:209
Remove job from queue
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
start()
Section titled “start()”start():
void
Defined in: packages/messaging/src/queue/job.processor.ts:133
Start processing jobs
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
Promise<void>
Defined in: packages/messaging/src/queue/job.processor.ts:146
Stop processing jobs
Returns
Section titled “Returns”Promise<void>