codeceptjs 3.5.5 → 3.5.7-beta.1

package/docs/helpers/TestCafe.md

@@ -107,7 +107,7 @@ I.amOnPage('/login'); // opens a login page
 
 -   `url` **[string][4]** url path or global url.
 
-Returns **void** automatically synchronized promise with recorder #!
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### appendField
 
@@ -122,9 +122,10 @@ I.appendField('password', secret('123456'));
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][4]** text value to append.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### attachFile
 
@@ -141,13 +142,14 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 -   `field`  
 -   `pathToFile` **[string][4]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### blur
 
 Remove focus from a text input, button, etc.
-Calls [blur][6] on the element.
+Calls [blur][7] on the element.
 
 Examples:
 
@@ -164,8 +166,10 @@ I.dontSee('#add-to-cart-btn');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** Playwright only: [Additional options][7] for available options object as 2nd argument.
+-   `locator` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+-   `options` **any?** Playwright only: [Additional options][8] for available options object as 2nd argument.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### checkOption
 
@@ -182,9 +186,10 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `field` **([string][4] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][4]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### clearCookie
 
@@ -199,8 +204,9 @@ I.clearCookie('test');
 #### Parameters
 
 -   `cookieName`  
--   `cookie` **[string][4]?** (optional, `null` by default) cookie name
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `cookie` **[string][4]?** (optional, `null` by default) cookie name 
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### clearField
 
@@ -215,8 +221,9 @@ I.clearField('#email');
 #### Parameters
 
 -   `field`  
--   `editable` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder.
+-   `editable` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder.
 
 ### click
 
@@ -244,9 +251,10 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][4]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSee
 
@@ -261,8 +269,9 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 #### Parameters
 
 -   `text` **[string][4]** which is not present.
--   `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][4] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCheckboxIsChecked
 
@@ -276,8 +285,9 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCookie
 
@@ -290,7 +300,8 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][4]** cookie name.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -305,7 +316,8 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeElement
 
@@ -317,8 +329,9 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|Strict locator.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeElementInDOM
 
@@ -330,8 +343,9 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|Strict locator.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInCurrentUrl
 
@@ -340,7 +354,8 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInField
 
@@ -354,9 +369,10 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **([string][4] | [object][6])** value to check.
+
+Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
 
 ### dontSeeInSource
 
@@ -370,7 +386,8 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][4]** to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### doubleClick
 
@@ -386,9 +403,10 @@ I.doubleClick('.btn.edit');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][4]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### executeScript
 
@@ -418,10 +436,10 @@ let date = await I.executeScript(function(el) {
 
 #### Parameters
 
--   `fn` **([string][4] | [function][8])** function to be executed in browser context.
+-   `fn` **([string][4] | [function][9])** function to be executed in browser context.
 -   `args` **...any** to be passed to function.
 
-Returns **[Promise][9]&lt;any>** script return value⚠️ returns a _promise_ which is synchronized internally by recorderIf a function returns a Promise It will wait for its resolution.
+Returns **[Promise][5]&lt;any>** script return valueIf a function returns a Promise It will wait for its resolution.
 
 ### fillField
 
@@ -441,13 +459,14 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** text value to fill.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **([string][4] | [object][6])** text value to fill.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### focus
 
-Calls [focus][6] on the matching element.
+Calls [focus][7] on the matching element.
 
 Examples:
 
@@ -459,9 +478,11 @@ I.see('#add-to-cart-bnt');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 -   `options` **any?** Playwright only: [Additional options][10] for available options object as 2nd argument.
 
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
+
 ### grabAttributeFrom
 
 Retrieves an attribute from an element located by CSS or XPath and returns it to test.
@@ -474,10 +495,10 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][9]&lt;[string][4]>** attribute value
+Returns **[Promise][5]&lt;[string][4]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -491,10 +512,10 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][9]&lt;[string][4]>** attribute value
+Returns **[Promise][5]&lt;[string][4]>** attribute value
 
 ### grabBrowserLogs
 
@@ -520,7 +541,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][4]?** cookie name. 
 
-Returns **([Promise][9]&lt;[string][4]> | [Promise][9]&lt;[Array][11]&lt;[string][4]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCurrentUrl
 
@@ -532,7 +553,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][9]&lt;[string][4]>** current URL
+Returns **[Promise][5]&lt;[string][4]>** current URL
 
 ### grabNumberOfVisibleElements
 
@@ -545,9 +566,9 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[number][12]>** number of visible elements
+Returns **[Promise][5]&lt;[number][11]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -558,7 +579,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][9]&lt;PageScrollPosition>** scroll position
+Returns **[Promise][5]&lt;PageScrollPosition>** scroll position
 
 ### grabSource
 
@@ -569,7 +590,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][9]&lt;[string][4]>** source code
+Returns **[Promise][5]&lt;[string][4]>** source code
 
 ### grabTextFrom
 
@@ -584,9 +605,9 @@ If multiple elements found returns first element.
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[string][4]>** attribute value
+Returns **[Promise][5]&lt;[string][4]>** attribute value
 
 ### grabTextFromAll
 
@@ -599,9 +620,9 @@ let pins = await I.grabTextFromAll('#pin li');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[Array][11]&lt;[string][4]>>** attribute value
+Returns **[Promise][5]&lt;[Array][12]&lt;[string][4]>>** attribute value
 
 ### grabValueFrom
 
@@ -615,9 +636,9 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[string][4]>** attribute value
+Returns **[Promise][5]&lt;[string][4]>** attribute value
 
 ### grabValueFromAll
 
@@ -630,9 +651,9 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[Array][11]&lt;[string][4]>>** attribute value
+Returns **[Promise][5]&lt;[Array][12]&lt;[string][4]>>** attribute value
 
 ### moveCursorTo
 
@@ -646,10 +667,11 @@ I.moveCursorTo('#submit', 5,5);
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][12]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### pressKey
 
@@ -665,8 +687,9 @@ I.pressKey(['Control','a']);
 
 #### Parameters
 
--   `key` **([string][4] | [Array][11]&lt;[string][4]>)** key or array of keys to press.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `key` **([string][4] | [Array][12]&lt;[string][4]>)** key or array of keys to press.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 
 [Valid key names](https://w3c.github.io/webdriver/#keyboard-actions) are:
@@ -709,7 +732,7 @@ Reload the current page.
 I.refreshPage();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### resizeWindow
 
@@ -718,9 +741,10 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][12]** width in pixels or `maximize`.
--   `height` **[number][12]** height in pixels.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `width` **[number][11]** width in pixels or `maximize`.
+-   `height` **[number][11]** height in pixels.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### rightClick
 
@@ -737,9 +761,10 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** clickable element located by CSS|XPath|strict locator.
+-   `context` **([string][4]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### saveElementScreenshot
 
@@ -752,9 +777,10 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][4]** file name to save.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### saveScreenshot
 
@@ -770,8 +796,9 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 #### Parameters
 
 -   `fileName` **[string][4]** file name to save.
--   `fullPage` **[boolean][14]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `fullPage` **[boolean][14]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollPageToBottom
 
@@ -781,7 +808,7 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollPageToTop
 
@@ -791,7 +818,7 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### scrollTo
 
@@ -805,10 +832,11 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][12]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### see
 
@@ -824,8 +852,9 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 #### Parameters
 
 -   `text` **[string][4]** expected on page.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `context` **([string][4]? | [object][6])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCheckboxIsChecked
 
@@ -839,8 +868,9 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCookie
 
@@ -853,7 +883,8 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][4]** cookie name.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeCurrentUrlEquals
 
@@ -869,7 +900,8 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeElement
 
@@ -882,8 +914,9 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** located by CSS|XPath|strict locator.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeElementInDOM
 
@@ -896,8 +929,9 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInCurrentUrl
 
@@ -910,7 +944,8 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][4]** a fragment to check
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInField
 
@@ -926,9 +961,10 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `field` **([string][4] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **([string][4] | [object][6])** value to check.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeInSource
 
@@ -941,7 +977,8 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][4]** value to check.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeNumberOfVisibleElements
 
@@ -954,9 +991,10 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][12]** number of elements.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `num` **[number][11]** number of elements.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### seeTextEquals
 
@@ -994,9 +1032,10 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][4] | [Array][11]&lt;any>)** visible text or value of option.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `select` **([string][4] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][4] | [Array][12]&lt;any>)** visible text or value of option.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### setCookie
 
@@ -1016,8 +1055,9 @@ I.setCookie([
 
 #### Parameters
 
--   `cookie` **(Cookie | [Array][11]&lt;Cookie>)** a cookie object or array of cookie objects.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `cookie` **(Cookie | [Array][12]&lt;Cookie>)** a cookie object or array of cookie objects.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### switchTo
 
@@ -1030,8 +1070,9 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### uncheckOption
 
@@ -1048,9 +1089,10 @@ I.uncheckOption('agree', '//form');
 
 #### Parameters
 
--   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `field` **([string][4] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][4]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### useTestCafeTo
 
@@ -1070,7 +1112,7 @@ I.useTestCafeTo('handle browser dialog', async ({ t }) {
 #### Parameters
 
 -   `description` **[string][4]** used to show in logs.
--   `fn` **[function][8]** async functuion that executed with TestCafe helper as argument
+-   `fn` **[function][9]** async functuion that executed with TestCafe helper as argument
 
 ### wait
 
@@ -1082,8 +1124,9 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][12]** number of second to wait.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `sec` **[number][11]** number of second to wait.
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForElement
 
@@ -1097,9 +1140,10 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForFunction
 
@@ -1118,10 +1162,11 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][4] | [function][8])** to be executed in browser context.
--   `argsOrSec` **([Array][11]&lt;any> | [number][12])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `fn` **([string][4] | [function][9])** to be executed in browser context.
+-   `argsOrSec` **([Array][12]&lt;any> | [number][11])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForInvisible
 
@@ -1134,9 +1179,10 @@ I.waitForInvisible('#popup');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForText
 
@@ -1152,9 +1198,10 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][4]** to wait for.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait 
--   `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator.
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][4] | [object][6])?** (optional) element located by CSS|XPath|strict locator. 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitForVisible
 
@@ -1167,9 +1214,10 @@ I.waitForVisible('#popup');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitInUrl
 
@@ -1182,8 +1230,9 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][4]** value to check.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitNumberOfVisibleElements
 
@@ -1195,10 +1244,11 @@ I.waitNumberOfVisibleElements('a', 3);
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][12]** number of elements.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `num` **[number][11]** number of elements.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitToHide
 
@@ -1211,9 +1261,10 @@ I.waitToHide('#popup');
 
 #### Parameters
 
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `locator` **([string][4] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ### waitUrlEquals
 
@@ -1227,8 +1278,9 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][4]** value to check.
--   `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
-    ⚠️ returns a _promise_ which is synchronized internally by recorder 
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
+
+Returns **[Promise][5]&lt;void>** automatically synchronized promise through #recorder
 
 ## getPageUrl
 
@@ -1246,21 +1298,21 @@ Client Functions
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[6]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[7]: https://playwright.dev/docs/api/class-locator#locator-blur
+[7]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
 
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[8]: https://playwright.dev/docs/api/class-locator#locator-blur
 
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
 [10]: https://playwright.dev/docs/api/class-locator#locator-focus
 
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
 [13]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value