Skip to main content

Interface: WorkflowInboundCallsInterceptor

Implement any of these methods to intercept Workflow inbound calls like execution, and signal and query handling.

Properties​

execute?​

optional execute?: (input, next) => Promise<unknown>

Called when Workflow execute method is called

Parameters​

input​

WorkflowExecuteInput

next​

OmitLastParam<(input: WorkflowExecuteInput, next: OmitLastParam<...>) => Promise<unknown>>

Returns​

Promise<unknown>

result of the Workflow execution

handleQuery?​

optional handleQuery?: (input, next) => Promise<unknown>

Called when a Workflow is queried

Parameters​

input​

QueryInput

next​

OmitLastParam<(input: QueryInput, next: OmitLastParam<...>) => Promise<unknown>>

Returns​

Promise<unknown>

result of the query

handleSignal?​

optional handleSignal?: (input, next) => Promise<void>

Called when signal is delivered to a Workflow execution

Parameters​

input​

SignalInput

next​

OmitLastParam<(input: SignalInput, next: OmitLastParam<...>) => Promise<void>>

Returns​

Promise<void>

handleUpdate?​

optional handleUpdate?: (input, next) => Promise<unknown>

Called when Update handler is called

Parameters​

input​

UpdateInput

next​

OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => Promise<unknown>>

Returns​

Promise<unknown>

result of the Update

validateUpdate?​

optional validateUpdate?: (input, next) => void

Called when update validator called

Parameters​

input​

UpdateInput

next​

OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => void>

Returns​

void