Class ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

WorkerInputVariables = any
CustomHeaderShape = any
WorkerOutputVariables = any

Hierarchy (View Summary)

TypedEmitter<ConnectionStatusEventMap>
- ZBWorkerBase
  - ZBWorker

Index

Constructors

constructor

new ZBWorkerBase<
    WorkerInputVariables = any,
    CustomHeaderShape = any,
    WorkerOutputVariables = any,
>(
    __namedParameters: ZBWorkerConstructorConfig<
        WorkerInputVariables,
        CustomHeaderShape,
        WorkerOutputVariables,
    >,
): ZBWorkerBase<
    WorkerInputVariables,
    CustomHeaderShape,
    WorkerOutputVariables,
>
Type Parameters
- WorkerInputVariables = any
- CustomHeaderShape = any
- WorkerOutputVariables = any
Parameters
- __namedParameters: ZBWorkerConstructorConfig<
      WorkerInputVariables,
      CustomHeaderShape,
      WorkerOutputVariables,
  >
Returns ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Overrides TypedEmitter.constructor
- Defined in src/zeebe/lib/ZBWorkerBase.ts:122

Properties

activeJobs

activeJobs: number = 0

backoffTimeout

backoffTimeout: undefined | Timeout

`Protected`cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

grpcClient

grpcClient: ZBGrpc

`Protected`logger

logger: StatefulLogInterceptor

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

`Protected`taskHandler

taskHandler: ZBWorkerTaskHandler<
    WorkerInputVariables,
    CustomHeaderShape,
    WorkerOutputVariables,
>

taskType

taskType: string

timeout

timeout: MaybeTimeDuration

`Protected`zbClient

zbClient: ZeebeGrpcClient

Methods

close

close(timeout?: number): Promise<null>
Returns a promise that the worker has stopped accepting tasks and has drained all current active tasks. Will reject if you try to call it more than once.
Parameters
- Optionaltimeout: number
Returns Promise<null>
- Defined in src/zeebe/lib/ZBWorkerBase.ts:225

debug

debug(msg: JSON): void
Parameters
- msg: JSON
Returns void
- Defined in src/zeebe/lib/ZBWorkerBase.ts:261

`Protected`drainOne

drainOne(): void
Returns void
- Defined in src/zeebe/lib/ZBWorkerBase.ts:269

emit

emit<K extends EventKey<ConnectionStatusEventMap>>(
eventName: K,
params?: ConnectionStatusEventMap[K],
): void
Type Parameters
- K extends EventKey<ConnectionStatusEventMap>
Parameters
- eventName: K
- Optionalparams: ConnectionStatusEventMap[K]
Returns void
Inherited from TypedEmitter.emit
- Defined in src/zeebe/lib/TypedEmitter.ts:25

error

error(msg: JSON): void
Parameters
- msg: JSON
Returns void
- Defined in src/zeebe/lib/ZBWorkerBase.ts:265

`Protected`handleJobs

handleJobs(jobs: Job<WorkerInputVariables, CustomHeaderShape>[]): void
Parameters
- jobs: Job<WorkerInputVariables, CustomHeaderShape>[]
Returns void
- Defined in src/zeebe/lib/ZBWorkerBase.ts:289

log

log(msg: JSON): void
Parameters
- msg: JSON
Returns void
- Defined in src/zeebe/lib/ZBWorkerBase.ts:257

`Protected`makeCompleteHandlers

makeCompleteHandlers<T>(
thisJob: Job<WorkerInputVariables, CustomHeaderShape>,
): JobCompletionInterface<T>
Type Parameters
- T
Parameters
- thisJob: Job<WorkerInputVariables, CustomHeaderShape>
Returns JobCompletionInterface<T>
- Defined in src/zeebe/lib/ZBWorkerBase.ts:298

off

off<K extends EventKey<ConnectionStatusEventMap>>(
eventName: K,
fn: EventReceiver<ConnectionStatusEventMap[K]>,
): void
Type Parameters
- K extends EventKey<ConnectionStatusEventMap>
Parameters
- eventName: K
- fn: EventReceiver<ConnectionStatusEventMap[K]>
Returns void
Inherited from TypedEmitter.off
- Defined in src/zeebe/lib/TypedEmitter.ts:21

on

on<K extends EventKey<ConnectionStatusEventMap>>(
    eventName: K,
    fn: EventReceiver<ConnectionStatusEventMap[K]>,
): ZBWorkerBase<
    WorkerInputVariables,
    CustomHeaderShape,
    WorkerOutputVariables,
>
Type Parameters
- K extends EventKey<ConnectionStatusEventMap>
Parameters
- eventName: K
- fn: EventReceiver<ConnectionStatusEventMap[K]>
Returns ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Inherited from TypedEmitter.on
- Defined in src/zeebe/lib/TypedEmitter.ts:16

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from TypedEmitter.removeAllListeners
- Defined in src/zeebe/lib/TypedEmitter.ts:29