Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

InvokeFn

InvokeFn: (input: TInput, context: StepExecutionContext) => void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> | Promise<void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>

The type of invocation function passed to a step.

Type Parameters#

TInputobjectOptional
The type of the input that the function expects.
TOutputobjectOptional
The type of the output that the function returns.
TCompensateInputobjectOptional
The type of the input that the compensation function expects.

Parameters#

inputTInput
contextStepExecutionContext

Returns#

void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> | Promise<void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> | Promise<void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>
The expected output based on the type parameter TOutput.
Was this page helpful?
Edit this page