Skip to main content

Interface: WorkflowInboundCallsInterceptor

workflow.WorkflowInboundCallsInterceptor

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

Methods#

create#

Optional create(input, next): Promise<WorkflowHandlers>

Called when Workflow is created from a factory function

Parameters#

NameType
inputWorkflowCreateInput
nextNext<this, "create">

Returns#

Promise<WorkflowHandlers>

the Workflow handlers


execute#

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

Called when Workflow execute method is called

Parameters#

NameType
inputWorkflowExecuteInput
nextNext<this, "execute">

Returns#

Promise<unknown>

result of the Workflow execution


handleQuery#

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

Called when a Workflow is queried

Parameters#

NameType
inputQueryInput
nextNext<this, "handleQuery">

Returns#

Promise<unknown>

result of the query


handleSignal#

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

Called when signal is delivered to a Workflow execution

Parameters#

NameType
inputSignalInput
nextNext<this, "handleSignal">

Returns#

Promise<void>