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

CompensateFn

CompensateFn: (input: T | undefined, context: StepExecutionContext) => unknown | Promise<unknown>

The type of compensation function passed to a step.

Type Parameters#

TobjectOptional
The type of the argument passed to the compensation function. If not specified, then it will be the same type as the invocation function's output.

Parameters#

inputT | undefined
contextStepExecutionContext
The step's context.

Returns#

unknown | Promise<unknown>unknown | Promise<unknown>
There's no expected type to be returned by the compensation function.
Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵