Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubmitProps

The proptypes for {@link StepDefinition.Submit}.

Hierarchy

  • SubmitProps

Index

Methods

Methods

onSubmit

  • onSubmit(): Promise<boolean>
  • The callback called when submission occurs.

    This callback is used to execute an asynchronous operation, so the implementation of {@link StepDefinition.Submit} must catch any exceptions thrown by the promise returned by this callback, and handle them appropriately, so they aren't lost to the ether.

    Returns true if the submission succeeded. Otherwise returns `false.

    Returns Promise<boolean>

Generated using TypeDoc