codeceptjs 3.3.1 → 3.3.4

package/docs/helpers/Puppeteer.md

@@ -279,7 +279,7 @@ I.amOnPage('/login'); // opens a login page
 
 -   `url` **[string][8]** url path or global url.
 
-Returns **[Promise][9]<any>** 
+Returns **void** automatically synchronized promise with recorder #!
 
 ### appendField
 
@@ -294,8 +294,7 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][8]** text value to append.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -316,8 +315,7 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 -   `locator` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][8]** local file path relative to codecept.json config file.
-
-Returns **[Promise][9]<any>** > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][10], downgrade to 2.0.0 if you face it.
+    [!] returns a _promise_ which is synchronized internally by recorder> ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][9], downgrade to 2.0.0 if you face it.
 
 ### cancelPopup
 
@@ -339,9 +337,8 @@ I.checkOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][8] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **[Promise][9]<any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### clearCookie
 
@@ -356,9 +353,8 @@ I.clearCookie('test');
 #### Parameters
 
 -   `name`  
--   `cookie` **[string][8]?** (optional, `null` by default) cookie name 
-
-Returns **[Promise][9]<any>** 
+-   `cookie` **[string][8]?** (optional, `null` by default) cookie name
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### clearField
 
@@ -374,8 +370,7 @@ I.clearField('#email');
 
 -   `field`  
 -   `editable` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### click
 
@@ -404,13 +399,12 @@ I.click({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][9]<any>** 
+-   `context` **([string][8]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### clickLink
 
@@ -423,13 +417,12 @@ I.clickLink('Logout', '#nav');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator 
-
-Returns **[Promise][9]<any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### closeCurrentTab
 
@@ -460,13 +453,12 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 #### Parameters
 
 -   `text` **[string][8]** which is not present.
--   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
-
-Returns **[Promise][9]<any>** 
+-   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### dontSeeCheckboxIsChecked
 
@@ -481,8 +473,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCookie
 
@@ -495,8 +486,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][8]** cookie name.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -511,8 +501,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
 
@@ -525,8 +514,8 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|Strict locator.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -543,8 +532,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|Strict locator.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInCurrentUrl
 
@@ -553,8 +541,7 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -570,8 +557,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][8]** value to check.
-
-Returns **[Promise][9]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
 
@@ -585,8 +571,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][8]** to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInTitle
 
@@ -599,8 +584,7 @@ I.dontSeeInTitle('Error');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### doubleClick
 
@@ -617,13 +601,12 @@ I.doubleClick('.btn.edit');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### downloadFile
 
@@ -648,8 +631,7 @@ I.dragAndDrop('#dragHandle', '#container');
 
 -   `srcElement` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 -   `destElement` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dragSlider
 
@@ -664,20 +646,20 @@ I.dragSlider('#slider', -70);
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][11]** position to drag. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `offsetX` **[number][10]** position to drag.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### executeAsyncScript
 
 Executes async script on page.
 Provided function should execute a passed callback (as first argument) to signal it is finished.
 
-Example: In Vue.js to make components completely rendered we are waiting for [nextTick][12].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][11].
 
 ```js
 I.executeAsyncScript(function(done) {
@@ -698,9 +680,8 @@ let val = await I.executeAsyncScript(function(url, done) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][8] | [function][13])** function to be executed in browser context.
-
-Returns **[Promise][9]&lt;any>** Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
+    [!] returns a _promise_ which is synchronized internally by recorderAsynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
+-   `fn` **([string][8] | [function][12])** function to be executed in browser context.
 
 ### executeScript
 
@@ -731,9 +712,8 @@ let date = await I.executeScript(function(el) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][8] | [function][13])** function to be executed in browser context.
-
-Returns **[Promise][9]&lt;any>** If a function returns a Promise It will wait for it resolution.
+    [!] returns a _promise_ which is synchronized internally by recorderIf a function returns a Promise It will wait for it resolution.
+-   `fn` **([string][8] | [function][12])** function to be executed in browser context.
 
 ### fillField
 
@@ -755,8 +735,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][8] | [object][6])** text value to fill.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -792,13 +772,12 @@ I.forceClick({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### grabAttributeFrom
 
@@ -815,7 +794,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][8]** attribute name.
 
-Returns **[Promise][9]&lt;[string][8]>** attribute value
+Returns **[Promise][13]&lt;[string][8]>** attribute value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -835,7 +814,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][8]** attribute name.
 
-Returns **[Promise][9]&lt;[Array][14]&lt;[string][8]>>** attribute value
+Returns **[Promise][13]&lt;[Array][14]&lt;[string][8]>>** attribute value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -850,7 +829,7 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-Returns **[Promise][9]&lt;[Array][14]&lt;any>>** 
+Returns **[Promise][13]&lt;[Array][14]&lt;any>>** 
 
 ### grabCookie
 
@@ -867,7 +846,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][8]?** cookie name. 
 
-Returns **([Promise][9]&lt;[string][8]> | [Promise][9]&lt;[Array][14]&lt;[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **([Promise][13]&lt;[string][8]> | [Promise][13]&lt;[Array][14]&lt;[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCssPropertyFrom
 
@@ -884,7 +863,7 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][8]** CSS property name.
 
-Returns **[Promise][9]&lt;[string][8]>** CSS value
+Returns **[Promise][13]&lt;[string][8]>** CSS value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -904,7 +883,7 @@ const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][8]** CSS property name.
 
-Returns **[Promise][9]&lt;[Array][14]&lt;[string][8]>>** CSS value
+Returns **[Promise][13]&lt;[Array][14]&lt;[string][8]>>** CSS value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -920,7 +899,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][9]&lt;[string][8]>** current URL
+Returns **[Promise][13]&lt;[string][8]>** current URL
 
 ### grabDataFromPerformanceTiming
 
@@ -945,7 +924,7 @@ let data = await I.grabDataFromPerformanceTiming();
 }
 ```
 
-Returns **[Promise][9]&lt;any>** 
+Returns **[Promise][13]&lt;any>** automatically synchronized promise through #recorder
 
 ### grabElementBoundingRect
 
@@ -973,7 +952,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][8]?** x, y, width or height of the given element.
 
-Returns **([Promise][9]&lt;DOMRect> | [Promise][9]&lt;[number][11]>)** Element bounding rectangle
+Returns **([Promise][13]&lt;DOMRect> | [Promise][13]&lt;[number][10]>)** Element bounding rectangle
 
 ### grabHTMLFrom
 
@@ -990,7 +969,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[string][8]>** HTML code for an element
+Returns **[Promise][13]&lt;[string][8]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -1006,7 +985,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[Array][14]&lt;[string][8]>>** HTML code for an element
+Returns **[Promise][13]&lt;[Array][14]&lt;[string][8]>>** HTML code for an element
 
 ### grabNumberOfOpenTabs
 
@@ -1017,7 +996,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][9]&lt;[number][11]>** number of open tabs
+Returns **[Promise][13]&lt;[number][10]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1032,7 +1011,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[number][11]>** number of visible elements
+Returns **[Promise][13]&lt;[number][10]>** number of visible elements
 
 
 
@@ -1048,7 +1027,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][13]&lt;PageScrollPosition>** scroll position
 
 ### grabPopupText
 
@@ -1058,7 +1037,7 @@ Grab the text within the popup. If no popup is visible then it will return null
 await I.grabPopupText();
 ```
 
-Returns **[Promise][9]&lt;([string][8] | null)>** 
+Returns **[Promise][13]&lt;([string][8] | null)>** 
 
 ### grabSource
 
@@ -1069,7 +1048,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][9]&lt;[string][8]>** source code
+Returns **[Promise][13]&lt;[string][8]>** source code
 
 ### grabTextFrom
 
@@ -1086,7 +1065,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[string][8]>** attribute value
+Returns **[Promise][13]&lt;[string][8]>** attribute value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1105,7 +1084,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[Array][14]&lt;[string][8]>>** attribute value
+Returns **[Promise][13]&lt;[Array][14]&lt;[string][8]>>** attribute value
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1120,7 +1099,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][9]&lt;[string][8]>** title
+Returns **[Promise][13]&lt;[string][8]>** title
 
 ### grabValueFrom
 
@@ -1136,7 +1115,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[string][8]>** attribute value
+Returns **[Promise][13]&lt;[string][8]>** attribute value
 
 ### grabValueFromAll
 
@@ -1151,7 +1130,7 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][9]&lt;[Array][14]&lt;[string][8]>>** attribute value
+Returns **[Promise][13]&lt;[Array][14]&lt;[string][8]>>** attribute value
 
 ### handleDownloads
 
@@ -1199,14 +1178,14 @@ I.moveCursorTo('#submit', 5,5);
 #### Parameters
 
 -   `locator` **([string][8] | [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][9]&lt;any>** 
+-   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### openNewTab
 
@@ -1280,8 +1259,7 @@ Some of the supported key names are:
 #### Parameters
 
 -   `key` **([string][8] | [Array][14]&lt;[string][8]>)** key or array of keys to press.
-
-Returns **[Promise][9]&lt;any>** _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][17]).
+    [!] returns a _promise_ which is synchronized internally by recorder_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][17]).
 
 ### pressKeyDown
 
@@ -1298,8 +1276,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][8]** name of key to press down.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### pressKeyUp
 
@@ -1316,8 +1293,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][8]** name of key to release.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### refreshPage
 
@@ -1327,7 +1303,7 @@ Reload the current page.
 I.refreshPage();
 ```
 
-Returns **[Promise][9]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### resizeWindow
 
@@ -1336,12 +1312,11 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][11]** width in pixels or `maximize`.
--   `height` **[number][11]** height in pixels.
-
-Returns **[Promise][9]&lt;any>** Unlike other drivers Puppeteer changes the size of a viewport, not the window!
-Puppeteer does not control the window of a browser so it can't adjust its real size.
-It also can't maximize a window.
+-   `width` **[number][10]** width in pixels or `maximize`.
+-   `height` **[number][10]** height in pixels.
+    [!] returns a _promise_ which is synchronized internally by recorderUnlike other drivers Puppeteer changes the size of a viewport, not the window!
+    Puppeteer does not control the window of a browser so it can't adjust its real size.
+    It also can't maximize a window.
 
 ### rightClick
 
@@ -1359,13 +1334,12 @@ I.rightClick('Click me', '.context');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### saveElementScreenshot
 
@@ -1380,8 +1354,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][8]** file name to save.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### saveScreenshot
 
@@ -1397,9 +1370,8 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 #### Parameters
 
 -   `fileName` **[string][8]** file name to save.
--   `fullPage` **[boolean][19]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `fullPage` **[boolean][19]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### scrollPageToBottom
 
@@ -1409,7 +1381,7 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-Returns **[Promise][9]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### scrollPageToTop
 
@@ -1419,7 +1391,7 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-Returns **[Promise][9]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### scrollTo
 
@@ -1434,10 +1406,9 @@ I.scrollTo('#submit', 5, 5);
 #### Parameters
 
 -   `locator` **([string][8] | [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][9]&lt;any>** 
+-   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### see
 
@@ -1453,13 +1424,12 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 #### Parameters
 
 -   `text` **[string][8]** expected on page.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8]? | [object][6])** (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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### seeAttributesOnElements
 
@@ -1473,8 +1443,8 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][6]** attributes and their values to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1493,8 +1463,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeCookie
 
@@ -1507,8 +1476,7 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][8]** cookie name.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeCssPropertiesOnElements
 
@@ -1522,8 +1490,8 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 -   `cssProperties` **[object][6]** object with CSS properties and their values to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1543,8 +1511,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
 
@@ -1558,8 +1525,8 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1577,8 +1544,7 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInCurrentUrl
 
@@ -1591,8 +1557,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][8]** a fragment to check
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -1610,8 +1575,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
 
@@ -1625,8 +1589,7 @@ I.seeInPopup('Popup text');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
 
@@ -1639,8 +1602,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInTitle
 
@@ -1653,8 +1615,7 @@ I.seeInTitle('Home Page');
 #### Parameters
 
 -   `text` **[string][8]** text value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfElements
 
@@ -1668,9 +1629,8 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `num` **[number][11]** number of elements.
-
-Returns **[Promise][9]&lt;any>** 
+-   `num` **[number][10]** number of elements.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1688,9 +1648,8 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `num` **[number][11]** number of elements.
-
-Returns **[Promise][9]&lt;any>** 
+-   `num` **[number][10]** number of elements.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1707,9 +1666,8 @@ I.seeTextEquals('text', 'h1');
 #### Parameters
 
 -   `text` **[string][8]** element value to check.
--   `context` **([string][8] | [object][6])?** element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8] | [object][6])?** element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### seeTitleEquals
 
@@ -1722,8 +1680,7 @@ I.seeTitleEquals('Test title.');
 #### Parameters
 
 -   `text` **[string][8]** value to check.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### selectOption
 
@@ -1750,8 +1707,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][8] | [Array][14]&lt;any>)** visible text or value of option.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### setCookie
 
@@ -1772,8 +1728,7 @@ I.setCookie([
 #### Parameters
 
 -   `cookie` **(Cookie | [Array][14]&lt;Cookie>)** a cookie object or array of cookie objects.
-
-Returns **[Promise][9]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### switchTo
 
@@ -1786,9 +1741,8 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `locator` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### switchToNextTab
 
@@ -1801,7 +1755,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` **[number][11]**  
+-   `num` **[number][10]**  
 
 ### switchToPreviousTab
 
@@ -1814,7 +1768,7 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` **[number][11]**  
+-   `num` **[number][10]**  
 
 ### type
 
@@ -1836,11 +1790,10 @@ I.type(['T', 'E', 'X', 'T']);
 #### Parameters
 
 -   `keys`  
--   `delay` **[number][11]?** (optional) delay in ms between key presses 
+-   `delay` **[number][10]?** (optional) delay in ms between key presses
+    [!] returns a _promise_ which is synchronized internally by recorder 
 -   `key` **([string][8] | [Array][14]&lt;[string][8]>)** or array of keys to type.
 
-Returns **[Promise][9]&lt;any>** 
-
 ### uncheckOption
 
 Unselects a checkbox or radio button.
@@ -1857,9 +1810,8 @@ I.uncheckOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][8] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### usePuppeteerTo
 
@@ -1879,7 +1831,7 @@ I.usePuppeteerTo('emulate offline mode', async ({ page }) {
 #### Parameters
 
 -   `description` **[string][8]** used to show in logs.
--   `fn` **[function][13]** async function that is executed with Puppeteer as argument
+-   `fn` **[function][12]** async function that is executed with Puppeteer as argument
 
 ### wait
 
@@ -1891,9 +1843,8 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][11]** number of second to wait.
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** number of second to wait.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### waitForClickable
 
@@ -1909,9 +1860,8 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `waitTimeout`  
--   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### waitForDetached
 
@@ -1925,9 +1875,8 @@ I.waitForDetached('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForElement
 
@@ -1942,9 +1891,9 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1958,9 +1907,8 @@ Element can be located by CSS or XPath.
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional) time in seconds to wait, 1 by default. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional) time in seconds to wait, 1 by default.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForFunction
 
@@ -1979,11 +1927,10 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][8] | [function][13])** to be executed in browser context.
--   `argsOrSec` **([Array][14]&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][9]&lt;any>** 
+-   `fn` **([string][8] | [function][12])** to be executed in browser context.
+-   `argsOrSec` **([Array][14]&lt;any> | [number][10])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForInvisible
 
@@ -1997,9 +1944,8 @@ I.waitForInvisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForNavigation
 
@@ -2022,8 +1968,8 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][13])** 
--   `sec` **[number][11]?** seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][12])** 
+-   `sec` **[number][10]?** seconds to wait 
 
 ### waitForResponse
 
@@ -2036,8 +1982,8 @@ I.waitForResponse(response => response.url() === 'http://example.com' && respons
 
 #### Parameters
 
--   `urlOrPredicate` **([string][8] | [function][13])** 
--   `sec` **[number][11]?** number of seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][12])** 
+-   `sec` **[number][10]?** number of seconds to wait 
 
 ### waitForText
 
@@ -2053,10 +1999,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][8]** to wait for.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
--   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForValue
 
@@ -2070,9 +2015,8 @@ I.waitForValue('//input', "GoodValue");
 
 -   `field` **([string][8] | [object][6])** input field.
 -   `value` **[string][8]** expected value.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForVisible
 
@@ -2086,9 +2030,8 @@ I.waitForVisible('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** This method accepts [React selectors][22].
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][22]. 
 
 ### waitInUrl
 
@@ -2101,9 +2044,8 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitNumberOfVisibleElements
 
@@ -2116,14 +2058,14 @@ I.waitNumberOfVisibleElements('a', 3);
 #### Parameters
 
 -   `locator` **([string][8] | [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][9]&lt;any>** 
+-   `num` **[number][10]** number of elements.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### waitToHide
 
@@ -2137,9 +2079,8 @@ I.waitToHide('#popup');
 #### Parameters
 
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitUrlEquals
 
@@ -2153,9 +2094,8 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][8]** value to check.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][9]&lt;any>** 
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 [1]: https://github.com/GoogleChrome/puppeteer
 
@@ -2173,15 +2113,15 @@ Returns **[Promise][9]&lt;any>**
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[9]: https://github.com/puppeteer/puppeteer/issues/5420
 
-[10]: https://github.com/puppeteer/puppeteer/issues/5420
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[11]: https://vuejs.org/v2/api/#Vue-nextTick
 
-[12]: https://vuejs.org/v2/api/#Vue-nextTick
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
 [14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array