setId method

Class: BatchInfoPlatform: WebdriverIO 5Language: JavaScript SDK:

Use this method to set the unique id of the batch.

You need to set the id explicitly if you want to batch tests that are run at different times or in different platforms or processes. For more information see Batching tests in a distributed environment

Syntax


let value = batchInfo.setId(value);

Parameters

value
Type:string
The unique id of the batch. If passed as null, and the environment variable APPLITOOLS_BATCH_ID is defined, then its value will be used as the id. If the environment variable is not defined then an internal unique id will be generated and used.

Return value

Type: BatchInfo

Remarks

If the id is not set, and the environment variable APPLITOOLS_BATCH_ID is defined, then its value will be used as the id. If the environment variable is not defined, then an internal unique id will be generated and used. Since this value is unique for each test run, if you don't set the id explicitly you can only batch tests that run in the current test run.