Skip to main content

Interface: WorkflowClientCallsInterceptor

client.WorkflowClientCallsInterceptor

Implement any of these methods to intercept WorkflowClient outbound calls

Methods

cancel

Optional cancel(input, next): Promise<IRequestCancelWorkflowExecutionResponse>

Intercept a service call to requestCancelWorkflowExecution

Parameters

NameType
inputWorkflowCancelInput
nextNext<this, "cancel">

Returns

Promise<IRequestCancelWorkflowExecutionResponse>


describe

Optional describe(input, next): Promise<IDescribeWorkflowExecutionResponse>

Intercept a service call to describeWorkflowExecution

Parameters

NameType
inputWorkflowDescribeInput
nextNext<this, "describe">

Returns

Promise<IDescribeWorkflowExecutionResponse>


query

Optional query(input, next): Promise<unknown>

Intercept a service call to queryWorkflow

Parameters

NameType
inputWorkflowQueryInput
nextNext<this, "query">

Returns

Promise<unknown>


signal

Optional signal(input, next): Promise<void>

Intercept a service call to signalWorkflowExecution

If you implement this method, signalWithStart most likely needs to be implemented too

Parameters

NameType
inputWorkflowSignalInput
nextNext<this, "signal">

Returns

Promise<void>


signalWithStart

Optional signalWithStart(input, next): Promise<string>

Intercept a service call to signalWithStartWorkflowExecution

Parameters

NameType
inputWorkflowSignalWithStartInput
nextNext<this, "signalWithStart">

Returns

Promise<string>


start

Optional start(input, next): Promise<string>

Intercept a service call to startWorkflowExecution

If you implement this method, signalWithStart most likely needs to be implemented too

Parameters

NameType
inputWorkflowStartInput
nextNext<this, "start">

Returns

Promise<string>


terminate

Optional terminate(input, next): Promise<ITerminateWorkflowExecutionResponse>

Intercept a service call to terminateWorkflowExecution

Parameters

NameType
inputWorkflowTerminateInput
nextNext<this, "terminate">

Returns

Promise<ITerminateWorkflowExecutionResponse>