Class JobWorker<T>`Abstract`

Type Parameters

T extends BaseJobWorkerContext = BaseJobWorkerContext

Hierarchy (View Summary)

JobWorker
- SendNotificationsWorker

Index

Constructors

Properties

logger loggerFactory workerConfig

Accessors

Methods

clearContext createLoggerForMethod createLoggerForRun onModuleInit run setContext

Constructors

constructor

new JobWorker<T extends BaseJobWorkerContext<Job> = BaseJobWorkerContext<Job>>(): JobWorker<
T,
>
Type Parameters
- T extends BaseJobWorkerContext<Job> = BaseJobWorkerContext<Job>
Returns JobWorker<T>

Properties

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

`Protected` `Readonly`workerConfig

workerConfig: WorkerConfigType

Accessors

ctx

get ctx(): T
Returns T
- Defined in src/modules/workers/abstracts/job-worker.ts:22

Methods

clearContext

clearContext(): void
Returns void
- Defined in src/modules/workers/abstracts/job-worker.ts:34

createLoggerForMethod

createLoggerForMethod(
method: string,
wctx?: WinstonLoggerContext,
): WinstonLogger
Parameters
- method: string
- Optionalwctx: WinstonLoggerContext
Returns WinstonLogger
- Defined in src/modules/workers/abstracts/job-worker.ts:44

createLoggerForRun

createLoggerForRun(wctx?: WinstonLoggerContext): WinstonLogger
Parameters
- Optionalwctx: WinstonLoggerContext
Returns WinstonLogger
- Defined in src/modules/workers/abstracts/job-worker.ts:57

onModuleInit

onModuleInit(): void
Returns void
- Defined in src/modules/workers/abstracts/job-worker.ts:38

`Abstract`run

run(): Promise<JobResult>
Returns Promise<JobResult>
- Defined in src/modules/workers/abstracts/job-worker.ts:61

setContext

setContext(ctx: T): void
Parameters
- ctx: T
Returns void
- Defined in src/modules/workers/abstracts/job-worker.ts:30