Skip to main content

TestResultsPlain type

Platform: Nightwatch
Language: Javascript
Puppeteer JavascriptSelenium JavascriptWdio4 JavascriptPlaywright JavascriptNightwatch JavascriptProtractor Javascript


Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this type is returned by the close method upon test completion.

accessibilityStatus property​

Syntax​

value = result.accessibilityStatus;

Type: TestAccessibilityStatus

Remarks​

For more information about the Contrast advisor feature see Contrast advisor.

appName property​

Syntax​

value = result.appName;

Type: string

The application name.

appUrls property​

Syntax​

value = result.appUrls;

Type: SessionUrlsPlain

See SessionUrls

The returned object has two properties, both are strings in the form of a URL:

batch

If you paste this URL into a browser then the browser will open the Test manager, displaying the batch results and all of its tests.

session

If you paste this URL into a browser then the browser will open the Test manager, displaying the batch results, with the focus on the test of this test result.

batchId property​

Syntax​

value = result.batchId;

Type: string

The batch ID.

batchName property​

Syntax​

value = result.batchName;

Type: string

The batch name.

branchName property​

Syntax​

value = result.branchName;

Type: string

The branch name.

duration property​

Syntax​

value = result.duration;

Type: number

The number of seconds the test ran for.

hostApp property​

Syntax​

value = result.hostApp;

Type: string

The name of the host application

hostDisplaySize property​

Syntax​

value = result.hostDisplaySize;

Type: RectangleSizePlain

The host display size.

hostOS property​

Syntax​

value = result.hostOS;

Type: string

The Host OS.

isAborted property​

Syntax​

value = result.isAborted;

Type: boolean

Use this property to retrieve true if the test was aborted.

isDifferent property​

Syntax​

value = result.isDifferent;

Type: boolean

isNew property​

Syntax​

value = result.isNew;

Type: boolean

Use this property to retrieve true if this is a new test, false otherwise.

matches property​

Syntax​

value = result.matches;

Type: number

matches property​

Syntax​

value = result.mismatches;

Type: number

missing property​

Syntax​

value = result.missing;

Type: number

name property​

Syntax​

value = result.name;

Type: string

The name of the test.

startedAt property​

Syntax​

value = result.startedAt;

Type: 

Date|string

In ISO 8601 format. For example, '2018-07-31T08:06:41.3932844+00:00'.

status property​

Syntax​

value = result.status;

Type: 

TestResultsStatus|'Failed'|'Passed'|'Unresolved'

Use this property to retrieve one of the following enumerated values:

  • TestResultsStatus.Passed
  • TestResultsStatus.Unresolved
  • TestResultsStatus.Failed

See TestResultsStatus for details.

steps property​

Syntax​

value = result.steps;

Type: number

stepsInfo property​

Syntax​

value = result.stepsInfo;

Type: StepInfoPlain[]

This is an array of StepInfo objects.

url property​

Syntax​

value = result.url;

Type: string