Class SyntheticsStepDetail

Object describing a step for a Synthetic test.

Hierarchy

  • SyntheticsStepDetail

Constructors

constructor

Properties

additionalProperties? allowFailure? browserErrors? checkType? description? duration? error? failure? playingTab? screenshotBucketKey? skipped? snapshotBucketKey? stepId? subTestStepDetails? timeToInteractive? type? url? value? vitalsMetrics? warnings?

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

Whether or not the step was allowed to fail.

Optional browserErrors

browserErrors?: SyntheticsBrowserError[]

Array of errors collected for a browser test.

Optional checkType

checkType?: SyntheticsCheckType

Type of assertion to apply in an API test.

Optional description

description?: string

Description of the test.

Optional duration

duration?: number

Total duration in millisecond of the test.

Optional error

error?: string

Error returned by the test.

Optional failure

failure?: SyntheticsBrowserTestResultFailure

The browser test failure details.

Optional playingTab

playingTab?: SyntheticsPlayingTab

Navigate between different tabs for your browser test.

Optional screenshotBucketKey

screenshotBucketKey?: boolean

Whether or not screenshots where collected by the test.

Optional skipped

skipped?: boolean

Whether or not to skip this step.

Optional snapshotBucketKey

snapshotBucketKey?: boolean

Whether or not snapshots where collected by the test.

Optional stepId

stepId?: number

The step ID.

Optional subTestStepDetails

subTestStepDetails?: SyntheticsStepDetail[]

If this step includes a sub-test. Subtests documentation.

Optional timeToInteractive

timeToInteractive?: number

Time before starting the step.

Optional type

type?: SyntheticsStepType

Step type used in your Synthetic test.

Optional url

url?: string

URL to perform the step against.

Optional value

value?: any

Value for the step.

Optional vitalsMetrics

vitalsMetrics?: SyntheticsCoreWebVitals[]

Array of Core Web Vitals metrics for the step.

Optional warnings

warnings?: SyntheticsStepDetailWarning[]

Warning collected that didn't failed the step.

Settings

Member Visibility

Theme

Generated using TypeDoc