The steps used in a Synthetic browser test.

Hierarchy

  • SyntheticsStep

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
allowFailure?: boolean

A boolean set to allow this step to fail.

alwaysExecute?: boolean

A boolean set to always execute this step even if the previous step failed or was skipped.

exitIfSucceed?: boolean

A boolean set to exit the test if the step succeeds.

isCritical?: boolean

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

name?: string

The name of the step.

noScreenshot?: boolean

A boolean set to skip taking a screenshot for the step.

params?: any

The parameters of the step.

timeout?: number

The time before declaring a step failed.

Step type used in your Synthetic test.

Generated using TypeDoc