Skip to main content

StepInfo class

When a test terminates, the close method returns an object with methods/properties defined by the TestResults class. Within the TestResults, there is an array of objects which have the properties defined by the class StepInfo. Each element of this array describes information for one step in the test.The properties of this object are used to retrieve information for a given step in the test results. Although there is no named class for this object, for convenience, it is documented in a class-like style.

You can access the array of objects with the step information using the stepsInfo property.

Require statement

const {StepInfo} = require('const EyesSDK = require('eyes.selenium'))');

apiUrls property

Syntax

value = stepinfo.apiUrls;

Type:

{ baselineImage: string; currentImage: string; diffImage: string };

See apiUrls for a detailed description of this object.

hasBaselineImage property

Syntax

value = stepinfo.hasBaselineImage;

Type: boolean

hasCheckpointImage property

Syntax

value = stepinfo.hasCheckpointImage;

Type: boolean

isDifferent property

Syntax

value = stepinfo.isDifferent;

Type: boolean

Returns true if a corresponding baseline image exists and the checkpoint image does not match that baseline image, Returns false if the checkpoint image matched the baseline image or if its a new checkpoint image (there is no baseline image yet).

name property

Syntax

value = stepinfo.name;

Type: string