InvokeFn

InvokeFn: (input: { [Key in keyof TInput]: TInput[Key] }, context: StepExecutionContext) => void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> | Promise<void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>

Type Parameters

TInputobjectRequired

The type of the input that the function expects.

TOutputobjectRequired

The type of the output that the function returns.

TCompensateInputobjectRequired

The type of the input that the compensation function expects.

Type declaration

The type of invocation function passed to a step.

Parameters

input{ [Key in keyof TInput]: TInput[Key] }Required

contextStepExecutionContextRequired

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.