Skip to content

Interface: KyooWorkerEvents

Describes the events and their callbacks for a KyooWorker instance

Events

EventTypeDescription
[captureRejectionSymbol](err: Error, event: EventName, ...args: any[]) => EventCallbackResultCalled in case a promise rejection happens when emitting an event
ack() => EventCallbackResultCalled when a job is acknowledged (ack is called)
acknowledged() => EventCallbackResultCalled when a job is acknowledged (either ack or nack is called)
log.alert(...args: any[]) => EventCallbackResultCalled when an "alert" level log is emitted
log.crit(...args: any[]) => EventCallbackResultCalled when a "crit" level log is emitted
log.debug(...args: any[]) => EventCallbackResultCalled when a "debug" level log is emitted
log.emerg(...args: any[]) => EventCallbackResultCalled when an "emerg" level log is emitted
log.error(...args: any[]) => EventCallbackResultCalled when an "error" level log is emitted
log.info(...args: any[]) => EventCallbackResultCalled when an "info" level log is emitted
log.notice(...args: any[]) => EventCallbackResultCalled when a "notice" level log is emitted
log.trace(...args: any[]) => EventCallbackResultCalled when a "trace" level log is emitted
log.warning(...args: any[]) => EventCallbackResultCalled when a "warning" level log is emitted
nack() => EventCallbackResultCalled when a job is rejected (nack is called)
paused() => EventCallbackResultCalled when the worker is paused
promise(promised: Promise<void>) => EventCallbackResultCalled when a promise to process a job is created
reject(err: unknown, promised: Promise<void>) => EventCallbackResultCalled when a job is processed and throws an error
resolve(promised: Promise<void>) => EventCallbackResultCalled when a job is processed without throwing an error
resumed() => EventCallbackResultCalled when the worker is resumed
settled(promised: Promise<void>) => EventCallbackResultCalled when a job is processed and the promise is settled
terminated() => EventCallbackResultCalled when the worker is terminated
tick() => EventCallbackResultCalled when the processor "ticks" (i.e. starts the processing loop)
tock() => EventCallbackResultCalled when the "tocks" (i.e. ends the processing loop)