Class BaseWorkerRunner

Base class for a worker runner.

Index

Constructors

Properties

appConfig jobsService logger loggerFactory moduleRef userManager workerConfig workerRegistry

Methods

createWorkerServiceAccountContext loop onModuleInit run runJob runJobById runJobFromQueue

Constructors

constructor

new BaseWorkerRunner(
jobsService: BaseJobsService,
workerRegistry: WorkerRegistry,
): BaseWorkerRunner
Parameters
- jobsService: BaseJobsService
- workerRegistry: WorkerRegistry
Returns BaseWorkerRunner
- Defined in src/modules/workers/workers.runner.ts:51

Properties

`Protected` `Readonly`appConfig

appConfig: AppConfigType

`Protected` `Readonly`jobsService

jobsService: BaseJobsService

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

`Protected` `Readonly`moduleRef

moduleRef: ModuleRef

`Protected` `Readonly`userManager

userManager: BaseUserManager

`Protected` `Readonly`workerConfig

workerConfig: WorkerConfigType

`Protected` `Readonly`workerRegistry

workerRegistry: WorkerRegistry

Methods

`Protected`createWorkerServiceAccountContext

createWorkerServiceAccountContext(): Promise<BaseServiceMethodContext>
Creates a service method context object for the worker's service account.

Returns Promise<BaseServiceMethodContext>
- A Promise that resolves with the service method context object.
- Defined in src/modules/workers/workers.runner.ts:60

`Protected`loop

loop(ctx: BaseServiceMethodContext): Promise<void>
Runs the worker in a loop, continuously processing jobs from the queue.
Parameters
- ctx: BaseServiceMethodContext
  The context object for the service method.
Returns Promise<void>
- A Promise that resolves when the worker loop is stopped.
- Defined in src/modules/workers/workers.runner.ts:102

onModuleInit

onModuleInit(): void
Returns void
- Defined in src/modules/workers/workers.runner.ts:43

run

run(): Promise<void>
Runs the worker in either loop mode or one-job mode, depending on the configuration.

Returns Promise<void>
- A Promise that resolves when the worker has finished running.
- Defined in src/modules/workers/workers.runner.ts:75

runJob

runJob(job: Job, ctx: BaseServiceMethodContext): Promise<void>
Runs a job asynchronously.
Parameters
- job: Job
  The job to be processed.
- ctx: BaseServiceMethodContext
  The context for the base service method.
Returns Promise<void>
A promise that resolves to void.
- Defined in src/modules/workers/workers.runner.ts:187

runJobById

runJobById(jobId: string, ctx: BaseServiceMethodContext): Promise<void>
Parameters
- jobId: string
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in src/modules/workers/workers.runner.ts:151

runJobFromQueue

runJobFromQueue(ctx: BaseServiceMethodContext): Promise<void>
Asynchronously runs a job from the queue.
Parameters
- ctx: BaseServiceMethodContext
  The context object for the service method.
Returns Promise<void>
- A Promise that resolves when the job is finished processing.
Throws
- If the job fails to process with an unhandled error or if it fails to process.
- Defined in src/modules/workers/workers.runner.ts:124