Class SyntheticsStep

The steps used in a Synthetic browser test.

Hierarchy

  • SyntheticsStep

Constructors

constructor

Properties

additionalProperties? allowFailure? alwaysExecute? exitIfSucceed? isCritical? name? noScreenshot? params? publicId? timeout? type?

Constructors

constructor

Properties

Optional additionalProperties

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

Optional allowFailure

allowFailure?: boolean

A boolean set to allow this step to fail.

Optional alwaysExecute

alwaysExecute?: boolean

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

Optional exitIfSucceed

exitIfSucceed?: boolean

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

Optional isCritical

isCritical?: boolean

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

Optional name

name?: string

The name of the step.

Optional noScreenshot

noScreenshot?: boolean

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

Optional params

params?: any

The parameters of the step.

Optional publicId

publicId?: string

The public ID of the step.

Optional timeout

timeout?: number

The time before declaring a step failed.

Optional type

type?: SyntheticsStepType

Step type used in your Synthetic test.

Settings

Member Visibility

Theme

Generated using TypeDoc