Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IStepParams<ArgsType, ReturnType>

IStepParams are supposed to be used as the parameters of a step creation function if a step requires mandatory step arguments.

template

ArgsType defines the type of the step arguments passed to the execution function.

template

ReturnType defines the return type of the execution function.

Type parameters

  • ArgsType: Object

  • ReturnType

Hierarchy

Index

Properties

Properties

args

args: ArgsType

Mandatory arguments that a step requires in order to be executed.

Optional cb

cb: function

An optional callback function that is invoked right after the execution of a step.

The return value of the step's execution function is passed to the callback function as a single parameter.

The step callback function can be used to retrieve and validate the state of the application right after the execution of a step.

Type declaration

    • (param: ReturnType): void
    • Parameters

      • param: ReturnType

      Returns void

Optional description

description: string

A short description of the interactions a step performs with the tested application.

Generated using TypeDoc