MessageJobProcessor
Defined in: packages/messaging/src/queue/job.processor.ts:358
Specific processor for message jobs
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MessageJobProcessor(
provider,options?,jobQueue?):MessageJobProcessor
Defined in: packages/messaging/src/queue/job.processor.ts:359
Parameters
Section titled “Parameters”provider
Section titled “provider”options?
Section titled “options?”Partial<JobProcessorOptions> = {}
jobQueue?
Section titled “jobQueue?”JobQueue<any>
Returns
Section titled “Returns”MessageJobProcessor
Overrides
Section titled “Overrides”Methods
Section titled “Methods”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
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>
Inherited from
Section titled “Inherited from”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”cleanup()
Section titled “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
Section titled “Returns”Promise<number>
Inherited from
Section titled “Inherited from”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”getJob()
Section titled “getJob()”getJob(
jobId):Promise<Job<any> |undefined>
Defined in: packages/messaging/src/queue/job.processor.ts:208
Get specific job by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<any> | undefined>
Inherited from
Section titled “Inherited from”getMetrics()
Section titled “getMetrics()”getMetrics():
JobProcessorMetrics
Defined in: packages/messaging/src/queue/job.processor.ts:166
Get current metrics
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”getQueueStatus()
Section titled “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
Section titled “Returns”Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>
Inherited from
Section titled “Inherited from”handle()
Section titled “handle()”handle<
T>(jobType,handler):void
Defined in: packages/messaging/src/queue/job.processor.ts:101
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
Inherited from
Section titled “Inherited from”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”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”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”queueBulkMessages()
Section titled “queueBulkMessages()”queueBulkMessages(
messageRequests,options?):Promise<string>
Defined in: packages/messaging/src/queue/job.processor.ts:638
Add bulk messages to the processing queue
Parameters
Section titled “Parameters”messageRequests
Section titled “messageRequests”options?
Section titled “options?”delay?
Section titled “delay?”number
metadata?
Section titled “metadata?”Record<string, any>
priority?
Section titled “priority?”number
Returns
Section titled “Returns”Promise<string>
queueMessage()
Section titled “queueMessage()”queueMessage(
messageRequest,options?):Promise<string>
Defined in: packages/messaging/src/queue/job.processor.ts:610
Add a message to the processing queue
Parameters
Section titled “Parameters”messageRequest
Section titled “messageRequest”options?
Section titled “options?”delay?
Section titled “delay?”number
metadata?
Section titled “metadata?”Record<string, any>
priority?
Section titled “priority?”number
Returns
Section titled “Returns”Promise<string>
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”JobProcessor.removeAllListeners
removeJob()
Section titled “removeJob()”removeJob(
jobId):Promise<boolean>
Defined in: packages/messaging/src/queue/job.processor.ts:215
Remove job from queue
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”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”scheduleMessage()
Section titled “scheduleMessage()”scheduleMessage(
messageRequest,scheduledAt,options?):Promise<string>
Defined in: packages/messaging/src/queue/job.processor.ts:656
Schedule a message for future delivery
Parameters
Section titled “Parameters”messageRequest
Section titled “messageRequest”scheduledAt
Section titled “scheduledAt”Date
options?
Section titled “options?”metadata?
Section titled “metadata?”Record<string, any>
Returns
Section titled “Returns”Promise<string>
start()
Section titled “start()”start():
void
Defined in: packages/messaging/src/queue/job.processor.ts:134
Start processing jobs
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”stop()
Section titled “stop()”stop():
Promise<void>
Defined in: packages/messaging/src/queue/job.processor.ts:147
Stop processing jobs
Returns
Section titled “Returns”Promise<void>