Class Worker<CommonTaskContext, TI>

Type Parameters

CommonTaskContext
TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>

Hierarchy

TypedEventEmitter<WorkerEvents<TI>, this>
- Worker

Constructors

constructor

new Worker<CommonTaskContext, TI>(opts, logMapping?): Worker<CommonTaskContext, TI>
Type Parameters
- CommonTaskContext
- TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>
Parameters
- opts: WorkerOptions
- Optional logMapping: Partial<TaskWorkerLogMapping>
Returns Worker<CommonTaskContext, TI>
Overrides (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; })<CommonTaskContext, TI>.constructor
- Defined in src/Worker.ts:87

Properties

`Private` buildLog

buildLog: TaskLogFunction

`Private` buildTaskUniqueId

buildTaskUniqueId: (() => string)

Type declaration

- (): string
- Returns string

`Private` logger

logger: MapLogger<TaskWorkerLogMapping>

`Private` stepFlowDelay

stepFlowDelay: number

`Private` tasks

tasks: Map<string, TaskWorkerInstance<FullTaskInstance<unknown, TI>>> = ...

Methods

addListener

addListener<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).addListener
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:22

addLogger

addLogger(logger): void
set logger instance (or change it if already set on constructor)
Parameters
- logger: ILoggerLike
  any common logger instance (console, log4js, winston, etc.)
Returns void
See
@avanio/logger-like for more info.

Example
```
worker.setLogger(console);
```
- Defined in src/Worker.ts:102

`Private` assertIfAbort

assertIfAbort(instance): void
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns void
- Defined in src/Worker.ts:754

`Private` assertInstance

assertInstance(instance, uuid): asserts instance is TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Parameters
- instance: undefined | TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- uuid: string
Returns asserts instance is TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- Defined in src/Worker.ts:455

deleteTask

deleteTask<ReturnType>(task): Promise<void>
Stop and delete this task from worker and wait for it to resolved/rejected
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
Returns Promise<void>
- Defined in src/Worker.ts:405

emit

emit<E>(event, ...args): boolean
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- Rest ...args: Parameters<WorkerEvents<TI>[E]>
Returns boolean
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).emit
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).eventNames
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:34

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).getMaxListeners
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:39

getOrInitializeTask

getOrInitializeTask<CType>(uuid, type, TaskClass, props, commonContext): FullTaskInstance<CType["data"], CType> | Promise<FullTaskInstance<CType["data"], CType>>
Get or initialize task instance and store it in worker
Type Parameters
- CType extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>
Parameters
- uuid: undefined | string
  Task uuid or undefined
- type: CType["type"]
  Task type
- TaskClass: ITaskConstructorInferFromInstance<CType>
  Task class
- props: CType["props"]
  Task props
- commonContext: CType["commonContext"]
  Common context
Returns FullTaskInstance<CType["data"], CType> | Promise<FullTaskInstance<CType["data"], CType>>
return new Task class instance or existing task instance
Example
```
const task = await worker.getOrInitializeTask(oldTaskUuid, 'type', MyTask, {prop1: 'value1'}, {common: 'context'});
```
- Defined in src/Worker.ts:182

getTaskByUuid

getTaskByUuid(uuid): undefined | FullTaskInstance<unknown, TI>
Get task instance by uuid
Parameters
- uuid: string
Returns undefined | FullTaskInstance<unknown, TI>
Task instance or undefined
- Defined in src/Worker.ts:349

getTaskCount

getTaskCount(): number
get current task count in task worker

Returns number
number of tasks
Example
```
const taskCount = worker.getTaskCount();
```
- Defined in src/Worker.ts:116

getTasksByType

getTasksByType<T>(type): FullTaskInstance<unknown, ITaskInstance<T, TTaskProps, unknown, CommonTaskContext>>[]
Get all task instances based on type
Type Parameters
- T extends string
Parameters
- type: T
Returns FullTaskInstance<unknown, ITaskInstance<T, TTaskProps, unknown, CommonTaskContext>>[]
Array of task instances
- Defined in src/Worker.ts:358

`Private` handleInstantJob

handleInstantJob(instance): Promise<void>
handle instance job start
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- this method won't throw any error
Throws
never
- Defined in src/Worker.ts:564

`Private` handlePreBuildDescription

handlePreBuildDescription(classInstance, currentWorkerInstance): Promise<void>
handle pre-build task description
Parameters
- classInstance: ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>
- currentWorkerInstance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- this method won't throw any error
Throws
never
- Defined in src/Worker.ts:825

`Private` handleReject

handleReject(instance, err): Promise<boolean>
handle task reject
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- err: Error
Returns Promise<boolean>
true if task should be retried
- Defined in src/Worker.ts:656

`Private` handleResolve

handleResolve(instance): Promise<boolean>
handle task resolve
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<boolean>
true if task should be retried
- Defined in src/Worker.ts:685

`Private` handleStopTask

handleStopTask(instance): Promise<void>
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- Defined in src/Worker.ts:479

`Private` handleTaskAbort

handleTaskAbort(instance): Promise<void>
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- Defined in src/Worker.ts:465

`Private` handleTaskInstanceBuild

handleTaskInstanceBuild<ReturnType>(abortController, task): TaskWorkerInstance<FullTaskInstance<ReturnType, TI>>
Type Parameters
- ReturnType
Parameters
- abortController: AbortController
- task: FullTaskInstance<ReturnType, TI>
Returns TaskWorkerInstance<FullTaskInstance<ReturnType, TI>>
- Defined in src/Worker.ts:760

`Private` handleTimedJob

handleTimedJob(instance): Promise<void>
handle timed jobs this resets task instance and run it again
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- this method won't throw any error
Throws
never
- Defined in src/Worker.ts:579

`Private` handleTriggerConnection

handleTriggerConnection(instance, isImport?): Promise<void>
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- isImport: boolean = false
Returns Promise<void>
- this method won't throw any error
Throws
never
- Defined in src/Worker.ts:518

importTasks

importTasks(data, importMapping): Promise<void>
method to import tasks back to worker (like from database or other storage)
Parameters
- data: InferDataFromInstance<TI>[]
- importMapping: ImportObjectMap<TI>
Returns Promise<void>
- Defined in src/Worker.ts:429

initializeTask

initializeTask<CType>(TaskClass, props, commonContext): Promise<FullTaskInstance<CType["data"], CType>>
Initialize and return task class instance and store it in worker
Type Parameters
- CType extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>
Parameters
- TaskClass: ITaskConstructorInferFromInstance<CType>
  Task class
- props: CType["props"]
  Task constructor properties
- commonContext: CType["commonContext"]
  Common context (all tasks shared this context type)
Returns Promise<FullTaskInstance<CType["data"], CType>>
Task class instance
Example
```
const task = await worker.initializeTask(MyTask, {prop1: 'value1'}, {common: 'context'});
```
- Defined in src/Worker.ts:129

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
Returns number
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).listenerCount
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:37

listeners

listeners<E>(event): WorkerEvents<TI>[E][]
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
Returns WorkerEvents<TI>[E][]
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).listeners
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:36

`Private` logKey

logKey(key, workerInstance, message): string
Handle log keys with buildLog
Parameters
- key: "start" | "abort" | "rejected" | "resolved" | "delete" | "flow_abort" | "flow_error" | "flow_limit" | "flow_retry" | "flow_sleep" | "not_start" | "status_change_default" | "status_change_error" | "status_change_info"
- workerInstance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- message: string
Returns string
log message as string
- Defined in src/Worker.ts:814

`Private` lookupSingleInstanceTask

lookupSingleInstanceTask<ReturnType>(taskInstance): undefined | TaskWorkerInstance<FullTaskInstance<ReturnType, TI>>
lookup single type task instance
Type Parameters
- ReturnType
Parameters
- taskInstance: FullTaskInstance<ReturnType, TI>
Returns undefined | TaskWorkerInstance<FullTaskInstance<ReturnType, TI>>
TaskWorkerInstance<FullTaskInstance<unknown, TI>> | undefined

Throws
never
- Defined in src/Worker.ts:778

`Private` notifyTaskUpdate

notifyTaskUpdate(workerInstance): Promise<void>
Parameters
- workerInstance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
- Defined in src/Worker.ts:806

off

off<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).off
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:28

on

on<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).on
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:23

once

once<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).once
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).prependListener
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).prependOnceListener
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<E>(event): WorkerEvents<TI>[E][]
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
Returns WorkerEvents<TI>[E][]
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).rawListeners
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:35

`Private` reloadImportTask

reloadImportTask(TaskClass, params): TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Parameters
- TaskClass: ITaskConstructorInferFromInstance<TI>
- params: InferDataFromInstance<TI>
Returns TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- Defined in src/Worker.ts:199

removeAllListeners

removeAllListeners<E>(event?): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- Optional event: E
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).removeAllListeners
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<E>(event, listener): this
Type Parameters
- E extends keyof WorkerEvents<TI>
Parameters
- event: E
- listener: WorkerEvents<TI>[E]
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).removeListener
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:30

`Private` resetTaskInstance

resetTaskInstance(instance): void
Reset task instance values.
- setup new abort controller
- reject old promise if task is instant and not resolved/rejected yet
- new DeferredPromise
- reset task start and end dates
- reset task status to Init
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns void
- Defined in src/Worker.ts:500

restartTask

restartTask<ReturnType>(task): Promise<void>
Restart this task instance if it's not in running state
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
  Task instance
Returns Promise<void>
Throws
if task is already running

Throws
if task is not allowed to restart
- Defined in src/Worker.ts:326

`Private` runTask

runTask(instance): Promise<void>
Run task instance.
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<void>
Throws
- this method won't throw any error
- Defined in src/Worker.ts:595

`Private` runTaskErrorHandler

runTaskErrorHandler(instance, err): Promise<boolean>
handle task error and possible retries
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- err: unknown
Returns Promise<boolean>
true if task should be retried

See
runTask flow and manual handleTaskAbort
- Defined in src/Worker.ts:617

`Private` runTaskFlow

runTaskFlow(instance): Promise<boolean>
run task flow
Parameters
- instance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
Returns Promise<boolean>
true if task should be retried
- Defined in src/Worker.ts:706

setLogMapping

setLogMapping(logMap): void
Parameters
- logMap: Partial<TaskWorkerLogMapping>
Returns void
- Defined in src/Worker.ts:106

setMaxListeners

setMaxListeners(maxListeners): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as { new <CommonTaskContext, TI extends ITaskInstance<string, TTaskProps, unknown, CommonTaskContext>>(): TypedEmitter<WorkerEvents<TI>>; }).setMaxListeners
- Defined in node_modules/.pnpm/typed-emitter@2.1.0/node_modules/typed-emitter/index.d.ts:40

`Private` setTaskStatus

setTaskStatus(workerInstance, status): Promise<void>
Parameters
- workerInstance: TaskWorkerInstance<FullTaskInstance<unknown, TI>>
- status: TaskStatusType
Returns Promise<void>
- Defined in src/Worker.ts:784

startTask

startTask<ReturnType>(task): Promise<void>
Start this task instance.
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
  Task instance
Returns Promise<void>
Promise that will be resolved when task is started
Throws
if task is already started

Example
```
await worker.startTask(task);
```
- Defined in src/Worker.ts:266

stopTask

stopTask<ReturnType>(task): Promise<void>
stop currently running task and wait for it to resolved/rejected
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
Returns Promise<void>
- Defined in src/Worker.ts:395

updateTask

updateTask(data): Promise<void>
Update task instance with new data, this is useful when task is updated from outside (like database events).

Note: this will not directly affect tasks flow directly, just updates task data and status.
Parameters
- data: InferDataFromInstance<TI>
  updated task data
Returns Promise<void>
- Defined in src/Worker.ts:370

waitTask

waitTask<ReturnType>(task): Promise<ReturnType>
Wait for this task to be resolved/rejected (also starts task if not started yet)
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
  Task instance
Returns Promise<ReturnType>
Promise of current task data

Throws
if task is not instant

Throws
if task is already started
- Defined in src/Worker.ts:284

waitTaskRun

waitTaskRun<ReturnType>(task): Promise<ReturnType>
Wait for this task to be resolved/rejected on each run (also starts task if not started yet)

Note: Task will be running and retried even if this Promise is thrown as new Promise will be created for each new run.
Type Parameters
- ReturnType
Parameters
- task: FullTaskInstance<ReturnType, TI>
  Task instance
Returns Promise<ReturnType>
Promise of single run task data

Throws
if task is not instant

Throws
if task is already started

Throws
if task will be retried and continue to next retry run
- Defined in src/Worker.ts:307

Class Worker<CommonTaskContext, TI>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Worker<CommonTaskContext, TI>

Properties

Private buildLog

Private buildTaskUniqueId

Type declaration

Returns string

Private logger

Private stepFlowDelay

Private tasks

Methods

addListener

Type Parameters

Parameters

Returns this

addLogger

Parameters

Returns void

See

Example

Private assertIfAbort

Parameters

Returns void

Private assertInstance

Parameters

Returns asserts instance is TaskWorkerInstance<FullTaskInstance<unknown, TI>>

deleteTask

Type Parameters

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

getOrInitializeTask

Type Parameters

Parameters

Returns FullTaskInstance<CType["data"], CType> | Promise<FullTaskInstance<CType["data"], CType>>

Example

getTaskByUuid

Parameters

Returns undefined | FullTaskInstance<unknown, TI>

getTaskCount

Returns number

Example

getTasksByType

Type Parameters

Parameters

Returns FullTaskInstance<unknown, ITaskInstance<T, TTaskProps, unknown, CommonTaskContext>>[]

Private handleInstantJob

Parameters

Returns Promise<void>

Throws

Private handlePreBuildDescription

Parameters

Returns Promise<void>

Throws

Private handleReject

Parameters

Returns Promise<boolean>

Private handleResolve

Parameters

Returns Promise<boolean>

Private handleStopTask

Parameters

Returns Promise<void>

`Private` buildLog

`Private` buildTaskUniqueId

`Private` logger

`Private` stepFlowDelay

`Private` tasks

`Private` assertIfAbort

`Private` assertInstance

`Private` handleInstantJob

`Private` handlePreBuildDescription

`Private` handleReject

`Private` handleResolve

`Private` handleStopTask

`Private` handleTaskAbort

`Private` handleTaskInstanceBuild

`Private` handleTimedJob

`Private` handleTriggerConnection

`Private` logKey

`Private` lookupSingleInstanceTask

`Private` notifyTaskUpdate

`Private` reloadImportTask