*
* Pauses execution for a specific amount of time. It is recommended to not use this command to wait for an
* element to show up. In order to avoid flaky test results it is better to use commands like
* [`waitForExist`](/docs/api/element/waitForExist) or other waitFor* commands.
*
* <example>
:pause.js
it('should pause the execution', async () => {
const starttime = new Date().getTime()
await browser.pause(3000)
const endtime = new Date().getTime()
console.log(endtime - starttime) // outputs: 3000
});
* </example>
*
* @alias browser.pause
* @param {number} milliseconds time in ms
* @type utility
*
*/
export function pause (
this: WebdriverIO.Browser,
milliseconds = 1000
): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, milliseconds))
}
