Skip to main content

Interface: WorkflowClientCallsInterceptor

client.WorkflowClientCallsInterceptor

Implement any of these methods to intercept WorkflowClient outbound calls

Implemented by

Properties

cancel

Optional cancel: (input: WorkflowCancelInput, next: OmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<...>) => Promise<IRequestCancelWorkflowExecutionResponse>>) => Promise<IRequestCancelWorkflowExecutionResponse>

Type declaration

▸ (input, next): Promise<IRequestCancelWorkflowExecutionResponse>

Intercept a service call to requestCancelWorkflowExecution

Parameters
NameType
inputWorkflowCancelInput
nextOmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<...>) => Promise<IRequestCancelWorkflowExecutionResponse>>
Returns

Promise<IRequestCancelWorkflowExecutionResponse>


describe

Optional describe: (input: WorkflowDescribeInput, next: OmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<...>) => Promise<IDescribeWorkflowExecutionResponse>>) => Promise<IDescribeWorkflowExecutionResponse>

Type declaration

▸ (input, next): Promise<IDescribeWorkflowExecutionResponse>

Intercept a service call to describeWorkflowExecution

Parameters
NameType
inputWorkflowDescribeInput
nextOmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<...>) => Promise<IDescribeWorkflowExecutionResponse>>
Returns

Promise<IDescribeWorkflowExecutionResponse>


query

Optional query: (input: WorkflowQueryInput, next: OmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>

Type declaration

▸ (input, next): Promise<unknown>

Intercept a service call to queryWorkflow

Parameters
NameType
inputWorkflowQueryInput
nextOmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>
Returns

Promise<unknown>


signal

Optional signal: (input: WorkflowSignalInput, next: OmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>) => Promise<void>

Type declaration

▸ (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
nextOmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>
Returns

Promise<void>


signalWithStart

Optional signalWithStart: (input: WorkflowSignalWithStartInput, next: OmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>

Type declaration

▸ (input, next): Promise<string>

Intercept a service call to signalWithStartWorkflowExecution

Parameters
NameType
inputWorkflowSignalWithStartInput
nextOmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>
Returns

Promise<string>


start

Optional start: (input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>

Type declaration

▸ (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
nextOmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<string>>
Returns

Promise<string>


terminate

Optional terminate: (input: WorkflowTerminateInput, next: OmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<...>) => Promise<ITerminateWorkflowExecutionResponse>>) => Promise<ITerminateWorkflowExecutionResponse>

Type declaration

▸ (input, next): Promise<ITerminateWorkflowExecutionResponse>

Intercept a service call to terminateWorkflowExecution

Parameters
NameType
inputWorkflowTerminateInput
nextOmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<...>) => Promise<ITerminateWorkflowExecutionResponse>>
Returns

Promise<ITerminateWorkflowExecutionResponse>