setBatch method

Class: ConfigurationPlatform: Selenium 4Language: JavaScript SDK:

Use this method to set the batch information for this test.

In the Test manager, all the results of tests that were batched together are shown together and can be managed and operated on as a group. See How to organize your tests with batches and How to group tests into batches using the SDK for details and an example.

Syntax


let configval = config.setBatch(value);

Parameters

value
Type:<a class ='link' href='/Content/api/eyes-sdk/index-gen/class-batchinfo-selenium4-javascript.htm'>BatchInfo</a>|BatchInfoObject
An object that defines the batch configuration.
BatchInfoObject
The type BatchInfoObject is defined as: {id:(string|undefined),name:(string|undefined),startedAt:(Date|string|undefined),sequenceName:(string|undefined),notifyOnCompletion:(boolean|undefined)}

Return value

Type: <a class ='link' href='/Content/api/eyes-sdk/index-gen/class-configuration-selenium4-javascript.htm'>Configuration</a>
The value returned is the object that called the method. This allows you to use a fluent style to call the setXXXX methods of this class.