Skip to main content

VisualGridRunner class

An object of this class is used to manage multiple Eyes sessions when working with the Ultrafast Grid.

To work without the Ultrafast Grid, use ClassicRunner instead of this class.

VisualGridRunner method


let runner = new VisualGridRunner(options);



Type: RunnerOptionsPlain [Optional ]

The maximum number of concurrent Eyes session.

Return value

Type: VisualGridRunner

getAllTestResults method


let result = await runner.getAllTestResults(throwErr);

let result = await runner.getAllTestResults();



Type: boolean [Optional ]

If a value of true is passed and any test did not pass, or there was a failure, then an exception is thrown. If a value of false is passed, then the object returned contains the test results and status of all the tests. The calling program should use the TestResultContainer.getException method to examine the exception status and, if it is null, check the various methods in the TestResults returned by the method getTestResults to see if the tests passed or mismatched where found. If no parameter is passed, then the default value is true.

Return value

Type: Promise<TestResultsSummary>