Interface: WorkflowInboundCallsInterceptor
workflow.WorkflowInboundCallsInterceptor
Implement any of these methods to intercept Workflow inbound calls like execution, and signal and query handling.
Implemented by
Properties
execute
• Optional execute: (input: WorkflowExecuteInput, next: OmitLastParam<(input: WorkflowExecuteInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>
Called when Workflow execute method is called
Type declaration
▸ (input, next): Promise<unknown>
Parameters
| Name | Type |
|---|---|
input | WorkflowExecuteInput |
next | OmitLastParam<(input: WorkflowExecuteInput, next: OmitLastParam<...>) => Promise<unknown>> |
Returns
Promise<unknown>
handleQuery
• Optional handleQuery: (input: QueryInput, next: OmitLastParam<(input: QueryInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>
Called when a Workflow is queried
Type declaration
▸ (input, next): Promise<unknown>
Parameters
| Name | Type |
|---|---|
input | QueryInput |
next | OmitLastParam<(input: QueryInput, next: OmitLastParam<...>) => Promise<unknown>> |
Returns
Promise<unknown>
handleSignal
• Optional handleSignal: (input: SignalInput, next: OmitLastParam<(input: SignalInput, next: OmitLastParam<...>) => Promise<void>>) => Promise<void>
Called when signal is delivered to a Workflow execution
Type declaration
▸ (input, next): Promise<void>
Parameters
| Name | Type |
|---|---|
input | SignalInput |
next | OmitLastParam<(input: SignalInput, next: OmitLastParam<...>) => Promise<void>> |
Returns
Promise<void>
handleUpdate
• Optional handleUpdate: (input: UpdateInput, next: OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>
Called when Update handler is called
Type declaration
▸ (input, next): Promise<unknown>
Parameters
| Name | Type |
|---|---|
input | UpdateInput |
next | OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => Promise<unknown>> |
Returns
Promise<unknown>
validateUpdate
• Optional validateUpdate: (input: UpdateInput, next: OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => void>) => void
Called when update validator called
Type declaration
▸ (input, next): void
Parameters
| Name | Type |
|---|---|
input | UpdateInput |
next | OmitLastParam<(input: UpdateInput, next: OmitLastParam<...>) => void> |
Returns
void