Class ZBStreamWorker

Implements

IZBJobWorker

Index

Constructors

constructor

new ZBStreamWorker(__namedParameters): ZBStreamWorker
Parameters
- __namedParameters: {
      grpcClient: ZBGrpc;
      log: StatefulLogInterceptor;
      zbClient: ZeebeGrpcClient;
  }
  - grpcClient: ZBGrpc
  - log: StatefulLogInterceptor
  - zbClient: ZeebeGrpcClient
Returns ZBStreamWorker
- Defined in src/zeebe/lib/ZBStreamWorker.ts:27

Properties

`Private` grpcClient

grpcClient: ZBGrpc

`Private` logger

logger: StatefulLogInterceptor

`Private` streams

streams: ClientReadableStream<unknown>[] = []

`Private` zbClient

zbClient: ZeebeGrpcClient

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/zeebe/lib/ZBStreamWorker.ts:103

`Private` completeJob

completeJob(jobKey, completedVariables?, taskType): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Parameters
- jobKey: string
- completedVariables: {} = {}
- taskType: any
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
- Defined in src/zeebe/lib/ZBStreamWorker.ts:235

debug

debug(msg): void
Parameters
- msg: JSON
Returns void
Implementation of IZBJobWorker.debug
- Defined in src/zeebe/lib/ZBStreamWorker.ts:116

error

error(msg): void
Parameters
- msg: JSON
Returns void
Implementation of IZBJobWorker.error
- Defined in src/zeebe/lib/ZBStreamWorker.ts:120

`Private` errorJob

errorJob(__namedParameters): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Parameters
- __namedParameters: {
      errorCode: string;
      errorMessage: string;
      job: Job<IInputVariables, ICustomHeaders>;
      variables: JSONDoc;
  }
  - errorCode: string
  - errorMessage: string
  - job: Job<IInputVariables, ICustomHeaders>
  - variables: JSONDoc
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
- Defined in src/zeebe/lib/ZBStreamWorker.ts:254

`Private` failJob

failJob(__namedParameters): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
Parameters
- __namedParameters: {
      errorMessage: string;
      job: Job<IInputVariables, ICustomHeaders>;
      retries?: number;
      retryBackOff?: number;
  }
  - errorMessage: string
  - job: Job<IInputVariables, ICustomHeaders>
  - Optional retries?: number
  - Optional retryBackOff?: number
Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
- Defined in src/zeebe/lib/ZBStreamWorker.ts:211

log

log(msg): void
Parameters
- msg: JSON
Returns void
Implementation of IZBJobWorker.log
- Defined in src/zeebe/lib/ZBStreamWorker.ts:112

`Protected` makeCompleteHandlers

makeCompleteHandlers<T>(thisJob, taskType): JobCompletionInterface<T>
Type Parameters
- T
Parameters
- thisJob: Job<IInputVariables, ICustomHeaders>
- taskType: string
Returns JobCompletionInterface<T>
- Defined in src/zeebe/lib/ZBStreamWorker.ts:124

streamJobs

streamJobs<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>(req): Promise<{
close: (() => void);
}>
Type Parameters
- WorkerInputVariables
- CustomHeaderShape
- WorkerOutputVariables
Parameters
- req: StreamActivatedJobsRequest & {
      customHeadersDto: (new (...args) => Readonly<CustomHeaderShape>);
      inputVariableDto: (new (...args) => Readonly<WorkerInputVariables>);
      taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
  }
Returns Promise<{
close: (() => void);
}>
- Defined in src/zeebe/lib/ZBStreamWorker.ts:45

Class ZBStreamWorker

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

grpcClient: ZBGrpc

log: StatefulLogInterceptor

zbClient: ZeebeGrpcClient

Returns ZBStreamWorker

Properties

Private grpcClient

Private logger

Private streams

Private zbClient

Methods

close

Returns Promise<void>

Private completeJob

Parameters

Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

debug

Parameters

Returns void

error

Parameters

Returns void

Private errorJob

Parameters

errorCode: string

errorMessage: string

job: Job<IInputVariables, ICustomHeaders>

variables: JSONDoc

Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

Private failJob

Parameters

errorMessage: string

job: Job<IInputVariables, ICustomHeaders>

Optional retries?: number

Optional retryBackOff?: number

Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

log

Parameters

Returns void

Protected makeCompleteHandlers

Type Parameters

Parameters

Returns JobCompletionInterface<T>

streamJobs

Type Parameters

Parameters

Returns Promise<{ close: (() => void); }>

Settings

Member Visibility

Theme

On This Page

`Private` grpcClient

`Private` logger

`Private` streams

`Private` zbClient

`Private` completeJob

`Private` errorJob

`Private` failJob

`Optional` retries?: number

`Optional` retryBackOff?: number

`Protected` makeCompleteHandlers

Returns Promise<{
close: (() => void);
}>