Skip to main content

Interface: WorkflowOutboundInterceptor

Interceptors of what workflow code issues.

Methods​

cancelRun()?​

optional cancelRun(input, next): Promise<void>

Parameters​

input​

CancelRunInput

next​

(input) => Promise<void>

Returns​

Promise<void>


continueAsNew()?​

optional continueAsNew(input, next): Promise<never>

Parameters​

input​

ContinueAsNewInput

next​

(input) => Promise<never>

Returns​

Promise<never>


getLogAttributes()?​

optional getLogAttributes(input, next): Record<string, Json>

Attributes added to every ctx.log line's data.

Parameters​

input​

Record<string, Json>

next​

(input) => Record<string, Json>

Returns​

Record<string, Json>


scheduleActivity()?​

optional scheduleActivity(input, next): Promise<unknown>

Parameters​

input​

ScheduleActivityInput

next​

(input) => Promise<unknown>

Returns​

Promise<unknown>


scheduleLocalActivity()?​

optional scheduleLocalActivity(input, next): Promise<unknown>

Parameters​

input​

ScheduleLocalActivityInput

next​

(input) => Promise<unknown>

Returns​

Promise<unknown>


sideEffect()?​

optional sideEffect(input, next): Json

Parameters​

input​

Record<string, never>

next​

() => Json

Returns​

Json


signalRun()?​

optional signalRun(input, next): Promise<void>

Parameters​

input​

SignalRunInput

next​

(input) => Promise<void>

Returns​

Promise<void>


startChild()?​

optional startChild(input, next): Promise<unknown>

Parameters​

input​

StartChildInput

next​

(input) => Promise<unknown>

Returns​

Promise<unknown>


startTimer()?​

optional startTimer(input, next): Promise<void>

Parameters​

input​

StartTimerInput

next​

(input) => Promise<void>

Returns​

Promise<void>


upsertContext()?​

optional upsertContext(input, next): void

Parameters​

input​

UpsertContextInput

next​

(input) => void

Returns​

void


upsertSearchAttributes()?​

optional upsertSearchAttributes(input, next): void

Parameters​

input​

UpsertSearchAttributesInput

next​

(input) => void

Returns​

void