Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

WorkerInputVariables
CustomHeaderShape
WorkerOutputVariables

Hierarchy

ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
- ZBWorker

Index

Constructors

Properties

activeJobs cancelWorkflowOnException grpcClient jobBatchMinSize logger maxJobsToActivate pollCount taskHandler taskType timeout zbClient

Methods

close debug drainOne emit error handleJob handleJobs log makeCompleteHandlers off on removeAllListeners

Constructors

constructor

new ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>(config: ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>): ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
- WorkerInputVariables
- CustomHeaderShape
- WorkerOutputVariables
Parameters
- config: ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Overrides ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>.constructor
- Defined in node_modules/zeebe-node/dist/zb/ZBWorker.d.ts:4

Properties

activeJobs

activeJobs: number

`Protected` cancelWorkflowOnException

cancelWorkflowOnException: boolean

grpcClient

grpcClient: ZBGrpc

jobBatchMinSize

jobBatchMinSize: number

`Protected` logger

logger: StatefulLogInterceptor

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number

`Protected` taskHandler

taskHandler: ZBBatchWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> | ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

timeout

timeout: MaybeTimeDuration

`Protected` zbClient

zbClient: ZBClient

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
- Optional timeout: number
Returns Promise<null>
Inherited from ZBWorkerBase.close
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:63

debug

debug(msg: any): void
Parameters
- msg: any
Returns void
Inherited from ZBWorkerBase.debug
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:65

`Protected` drainOne

drainOne(): void
Returns void
Inherited from ZBWorkerBase.drainOne
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:67

emit

emit<K>(eventName: K, params?: {
    close: "close";
    connectionError: "connectionError";
    ready: "ready";
    unknown: "unknown";
}[K]): void
Type Parameters
- K extends EventKey<{
      close: "close";
      connectionError: "connectionError";
      ready: "ready";
      unknown: "unknown";
  }>
Parameters
- eventName: K
- Optional params: {
      close: "close";
      connectionError: "connectionError";
      ready: "ready";
      unknown: "unknown";
  }[K]
Returns void
Inherited from ZBWorkerBase.emit
- Defined in node_modules/zeebe-node/dist/lib/TypedEmitter.d.ts:13

error

error(msg: any): void
Parameters
- msg: any
Returns void
Inherited from ZBWorkerBase.error
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:66

`Protected` handleJob

handleJob(job: Job<WorkerInputVariables, CustomHeaderShape>): Promise<void>
Parameters
- job: Job<WorkerInputVariables, CustomHeaderShape>
Returns Promise<void>
- Defined in node_modules/zeebe-node/dist/zb/ZBWorker.d.ts:6

`Protected` handleJobs

handleJobs(jobs: Job<WorkerInputVariables, CustomHeaderShape>[]): void
Parameters
- jobs: Job<WorkerInputVariables, CustomHeaderShape>[]
Returns void
Overrides ZBWorkerBase.handleJobs
- Defined in node_modules/zeebe-node/dist/zb/ZBWorker.d.ts:5

log

log(msg: any): void
Parameters
- msg: any
Returns void
Inherited from ZBWorkerBase.log
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:64

`Protected` makeCompleteHandlers

makeCompleteHandlers<T>(thisJob: Job<IInputVariables, ICustomHeaders>): JobCompletionInterface<T>
Type Parameters
- T
Parameters
- thisJob: Job<IInputVariables, ICustomHeaders>
Returns JobCompletionInterface<T>
Inherited from ZBWorkerBase.makeCompleteHandlers
- Defined in node_modules/zeebe-node/dist/lib/ZBWorkerBase.d.ts:69

off

off<K>(eventName: K, fn: EventReceiver): void
Type Parameters
- K extends EventKey<{
      close: "close";
      connectionError: "connectionError";
      ready: "ready";
      unknown: "unknown";
  }>
Parameters
- eventName: K
- fn: EventReceiver
Returns void
Inherited from ZBWorkerBase.off
- Defined in node_modules/zeebe-node/dist/lib/TypedEmitter.d.ts:12

on

on<K>(eventName: K, fn: EventReceiver): ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Type Parameters
- K extends EventKey<{
      close: "close";
      connectionError: "connectionError";
      ready: "ready";
      unknown: "unknown";
  }>
Parameters
- eventName: K
- fn: EventReceiver
Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
Inherited from ZBWorkerBase.on
- Defined in node_modules/zeebe-node/dist/lib/TypedEmitter.d.ts:11

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from ZBWorkerBase.removeAllListeners
- Defined in node_modules/zeebe-node/dist/lib/TypedEmitter.d.ts:14

Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

WorkerInputVariables

CustomHeaderShape

WorkerOutputVariables

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

WorkerInputVariables

CustomHeaderShape

WorkerOutputVariables

Parameters

config: ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Returns ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Properties

activeJobs

Protected cancelWorkflowOnException

grpcClient

jobBatchMinSize

Protected logger

maxJobsToActivate

pollCount

Protected taskHandler

taskType

timeout

Protected zbClient

Methods

close

Parameters

Optional timeout: number

Returns Promise<null>

debug

Parameters

msg: any

Returns void

Protected drainOne

Returns void

emit

Type Parameters

K extends EventKey<{ close: "close"; connectionError: "connectionError"; ready: "ready"; unknown: "unknown"; }>

Parameters

eventName: K

Optional params: { close: "close"; connectionError: "connectionError"; ready: "ready"; unknown: "unknown"; }[K]

Returns void

error

Parameters

msg: any

Returns void

Protected handleJob

Parameters

job: Job<WorkerInputVariables, CustomHeaderShape>

Returns Promise<void>

Protected handleJobs

Parameters

jobs: Job<WorkerInputVariables, CustomHeaderShape>[]

Returns void

log

Parameters

msg: any

Returns void

Protected makeCompleteHandlers

Type Parameters

T

Parameters

thisJob: Job<IInputVariables, ICustomHeaders>

Returns JobCompletionInterface<T>

off

Type Parameters

K extends EventKey<{ close: "close"; connectionError: "connectionError"; ready: "ready"; unknown: "unknown"; }>

Parameters

eventName: K

fn: EventReceiver

Returns void

on

Type Parameters

`Protected` cancelWorkflowOnException

`Protected` logger

`Protected` taskHandler

`Protected` zbClient

`Optional` timeout: number

`Protected` drainOne

K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>

`Optional` params: {
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}[K]

`Protected` handleJob

`Protected` handleJobs

`Protected` makeCompleteHandlers

K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>

K extends EventKey<{
close: "close";
connectionError: "connectionError";
ready: "ready";
unknown: "unknown";
}>