codeceptjs 3.3.1 → 3.3.4

package/docs/helpers/WebDriver.md

@@ -449,7 +449,7 @@ I.amOnPage('/login'); // opens a login page
 
 -   `url` **[string][19]** url path or global url.
 
-Returns **[Promise][21]<any>** 
+Returns **void** automatically synchronized promise with recorder #!
 
 ### appendField
 
@@ -464,8 +464,8 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][19]** text value to append.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -486,8 +486,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 -   `locator` **([string][19] | [object][18])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][19]** local file path relative to codecept.json config file.
-
-Returns **[Promise][21]<any>** Appium: not tested
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested
 
 ### cancelPopup
 
@@ -509,9 +509,9 @@ I.checkOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][19] | [object][18])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **[Promise][21]<any>** Appium: not tested
+-   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS | XPath | strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested 
 
 ### clearCookie
 
@@ -525,9 +525,8 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie` **[string][19]?** (optional, `null` by default) cookie name 
-
-Returns **[Promise][21]<any>** 
+-   `cookie` **[string][19]?** (optional, `null` by default) cookie name
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### clearField
 
@@ -543,8 +542,7 @@ I.clearField('#email');
 
 -   `field`  
 -   `editable` **([string][19] | [object][18])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### click
 
@@ -573,13 +571,12 @@ I.click({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][19]? | [object][18] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][21]<any>** 
+-   `context` **([string][19]? | [object][18] | 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)
-
+ 
 
 ### closeCurrentTab
 
@@ -589,7 +586,7 @@ Close current tab.
 I.closeCurrentTab();
 ```
 
-Returns **[Promise][21]<any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### closeOtherTabs
 
@@ -599,11 +596,11 @@ Close all tabs except for the current one.
 I.closeOtherTabs();
 ```
 
-Returns **[Promise][21]<any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### defineTimeout
 
-Set [WebDriver timeouts][22] in realtime.
+Set [WebDriver timeouts][21] in realtime.
 
 Timeouts are expected to be passed as object:
 
@@ -629,13 +626,12 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 #### Parameters
 
 -   `text` **[string][19]** which is not present.
--   `context` **([string][19] | [object][18])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
-
-Returns **[Promise][21]<any>** 
+-   `context` **([string][19] | [object][18])?** (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
 
@@ -650,8 +646,8 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][21]<any>** Appium: not tested
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested
 
 ### dontSeeCookie
 
@@ -664,8 +660,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][19]** cookie name.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -680,8 +675,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][19]** value to check.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
 
@@ -694,8 +688,8 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|Strict locator.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -712,8 +706,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|Strict locator.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInCurrentUrl
 
@@ -722,8 +715,7 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][19]** value to check.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -739,8 +731,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][19]** value to check.
-
-Returns **[Promise][21]<any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
 
@@ -754,8 +745,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][19]** to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInTitle
 
@@ -768,8 +758,7 @@ I.dontSeeInTitle('Error');
 #### Parameters
 
 -   `text` **[string][19]** value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### doubleClick
 
@@ -786,13 +775,12 @@ I.doubleClick('.btn.edit');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19]? | [object][18])** (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)
-
+ 
 
 ### dragAndDrop
 
@@ -806,8 +794,8 @@ I.dragAndDrop('#dragHandle', '#container');
 
 -   `srcElement` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 -   `destElement` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][21]&lt;any>** Appium: not tested
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested
 
 ### dragSlider
 
@@ -822,16 +810,15 @@ I.dragSlider('#slider', -70);
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][23]** position to drag. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `offsetX` **[number][22]** position to drag.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### 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][24].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][23].
 
 ```js
 I.executeAsyncScript(function(done) {
@@ -852,9 +839,8 @@ let val = await I.executeAsyncScript(function(url, done) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][19] | [function][25])** function to be executed in browser context.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+-   `fn` **([string][19] | [function][24])** function to be executed in browser context.
 
 ### executeScript
 
@@ -885,9 +871,8 @@ let date = await I.executeScript(function(el) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][19] | [function][25])** function to be executed in browser context.
-
-Returns **[Promise][21]&lt;any>** Wraps [execute][26] command.
+    [!] returns a _promise_ which is synchronized internally by recorderWraps [execute][25] command.
+-   `fn` **([string][19] | [function][24])** function to be executed in browser context.
 
 ### fillField
 
@@ -909,13 +894,13 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][19] | [object][18])** text value to fill.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
 
-{{ custom }}
+    {{ custom }}
 
 ### forceClick
 
@@ -947,13 +932,12 @@ I.forceClick({css: 'nav a.login'});
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19]? | [object][18])** (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)
-
+ 
 
 ### forceRightClick
 
@@ -975,13 +959,12 @@ I.forceRightClick('Menu');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19]? | [object][18])** (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)
-
+ 
 
 ### grabAllWindowHandles
 
@@ -992,7 +975,7 @@ Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
 const windows = await I.grabAllWindowHandles();
 ```
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** 
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** 
 
 ### grabAttributeFrom
 
@@ -1009,7 +992,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][19]** attribute name.
 
-Returns **[Promise][21]&lt;[string][19]>** attribute value
+Returns **[Promise][26]&lt;[string][19]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -1025,7 +1008,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][19]** attribute name.
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** attribute value
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** attribute value
 
 ### grabBrowserLogs
 
@@ -1037,7 +1020,7 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-Returns **([Promise][21]&lt;[Array][27]&lt;[object][18]>> | [undefined][28])** all browser logs
+Returns **([Promise][26]&lt;[Array][27]&lt;[object][18]>> | [undefined][28])** all browser logs
 
 ### grabCookie
 
@@ -1054,7 +1037,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][19]?** cookie name. 
 
-Returns **([Promise][21]&lt;[string][19]> | [Promise][21]&lt;[Array][27]&lt;[string][19]>>)** attribute value
+Returns **([Promise][26]&lt;[string][19]> | [Promise][26]&lt;[Array][27]&lt;[string][19]>>)** attribute value
 
 ### grabCssPropertyFrom
 
@@ -1071,7 +1054,7 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][19]** CSS property name.
 
-Returns **[Promise][21]&lt;[string][19]>** CSS value
+Returns **[Promise][26]&lt;[string][19]>** CSS value
 
 ### grabCssPropertyFromAll
 
@@ -1087,7 +1070,7 @@ const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][19]** CSS property name.
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** CSS value
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** CSS value
 
 ### grabCurrentUrl
 
@@ -1099,7 +1082,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][21]&lt;[string][19]>** current URL
+Returns **[Promise][26]&lt;[string][19]>** current URL
 
 ### grabCurrentWindowHandle
 
@@ -1110,7 +1093,7 @@ Useful for referencing it when calling `I.switchToWindow(handle)`
 const window = await I.grabCurrentWindowHandle();
 ```
 
-Returns **[Promise][21]&lt;[string][19]>** 
+Returns **[Promise][26]&lt;[string][19]>** 
 
 ### grabElementBoundingRect
 
@@ -1138,7 +1121,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][19]?** x, y, width or height of the given element.
 
-Returns **([Promise][21]&lt;DOMRect> | [Promise][21]&lt;[number][23]>)** Element bounding rectangle
+Returns **([Promise][26]&lt;DOMRect> | [Promise][26]&lt;[number][22]>)** Element bounding rectangle
 
 ### grabGeoLocation
 
@@ -1149,7 +1132,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let geoLocation = await I.grabGeoLocation();
 ```
 
-Returns **[Promise][21]&lt;{latitude: [number][23], longitude: [number][23], altitude: [number][23]}>** 
+Returns **[Promise][26]&lt;{latitude: [number][22], longitude: [number][22], altitude: [number][22]}>** 
 
 ### grabHTMLFrom
 
@@ -1166,7 +1149,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][19]>** HTML code for an element
+Returns **[Promise][26]&lt;[string][19]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -1182,7 +1165,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** HTML code for an element
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** HTML code for an element
 
 ### grabNumberOfOpenTabs
 
@@ -1193,7 +1176,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][21]&lt;[number][23]>** number of open tabs
+Returns **[Promise][26]&lt;[number][22]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1208,7 +1191,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[number][23]>** number of visible elements
+Returns **[Promise][26]&lt;[number][22]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -1219,7 +1202,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][21]&lt;PageScrollPosition>** scroll position
+Returns **[Promise][26]&lt;PageScrollPosition>** scroll position
 
 ### grabPopupText
 
@@ -1229,7 +1212,7 @@ Grab the text within the popup. If no popup is visible then it will return null.
 await I.grabPopupText();
 ```
 
-Returns **[Promise][21]&lt;[string][19]>** 
+Returns **[Promise][26]&lt;[string][19]>** 
 
 ### grabSource
 
@@ -1240,7 +1223,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][21]&lt;[string][19]>** source code
+Returns **[Promise][26]&lt;[string][19]>** source code
 
 ### grabTextFrom
 
@@ -1257,7 +1240,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][19]>** attribute value
+Returns **[Promise][26]&lt;[string][19]>** attribute value
 
 ### grabTextFromAll
 
@@ -1272,7 +1255,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** attribute value
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** attribute value
 
 ### grabTitle
 
@@ -1283,7 +1266,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][21]&lt;[string][19]>** title
+Returns **[Promise][26]&lt;[string][19]>** title
 
 ### grabValueFrom
 
@@ -1299,7 +1282,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][19] | [object][18])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[string][19]>** attribute value
+Returns **[Promise][26]&lt;[string][19]>** attribute value
 
 ### grabValueFromAll
 
@@ -1314,7 +1297,7 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][19] | [object][18])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][21]&lt;[Array][27]&lt;[string][19]>>** attribute value
+Returns **[Promise][26]&lt;[Array][27]&lt;[string][19]>>** attribute value
 
 ### moveCursorTo
 
@@ -1331,10 +1314,9 @@ I.moveCursorTo('#submit', 5,5);
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 -   `xOffset`  
 -   `yOffset`  
--   `offsetX` **[number][23]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][23]** (optional, `0` by default) Y-axis offset. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `offsetX` **[number][22]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][22]** (optional, `0` by default) Y-axis offset.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### openNewTab
 
@@ -1344,13 +1326,13 @@ Open new tab and switch to it.
 I.openNewTab();
 ```
 
+[!] returns a _promise_ which is synchronized internally by recorder
+
 #### Parameters
 
 -   `url`   
 -   `windowName`   
 
-Returns **[Promise][21]&lt;any>** 
-
 ### pressKey
 
 Presses a key in the browser (on a focused element).
@@ -1415,8 +1397,7 @@ Some of the supported key names are:
 #### Parameters
 
 -   `key` **([string][19] | [Array][27]&lt;[string][19]>)** key or array of keys to press.
-
-Returns **[Promise][21]&lt;any>** _Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+    [!] returns a _promise_ which is synchronized internally by recorder_Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
 
 ### pressKeyDown
 
@@ -1433,8 +1414,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][19]** name of key to press down.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### pressKeyUp
 
@@ -1451,8 +1431,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][19]** name of key to release.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### refreshPage
 
@@ -1462,7 +1441,7 @@ Reload the current page.
 I.refreshPage();
 ```
 
-Returns **[Promise][21]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### resizeWindow
 
@@ -1471,10 +1450,10 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` **[number][23]** width in pixels or `maximize`.
--   `height` **[number][23]** height in pixels.
-
-Returns **[Promise][21]&lt;any>** Appium: not tested in web, in apps doesn't work
+-   `width` **[number][22]** width in pixels or `maximize`.
+-   `height` **[number][22]** height in pixels.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested in web, in apps doesn't work
 
 ### rightClick
 
@@ -1492,13 +1471,12 @@ I.rightClick('Click me', '.context');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19]? | [object][18])** (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)
-
+ 
 
 ### runInWeb
 
@@ -1517,8 +1495,6 @@ Placeholder for ~ locator only test case write once run on both Appium and WebDr
 -   `caps` **any** 
 -   `fn` **any** 
 
-Returns **[Promise][21]&lt;any>** 
-
 ### runOnIOS
 
 Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
@@ -1528,8 +1504,6 @@ Placeholder for ~ locator only test case write once run on both Appium and WebDr
 -   `caps` **any** 
 -   `fn` **any** 
 
-Returns **[Promise][21]&lt;any>** 
-
 ### saveElementScreenshot
 
 Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
@@ -1543,8 +1517,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][19]** file name to save.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### saveScreenshot
 
@@ -1560,9 +1533,8 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 #### Parameters
 
 -   `fileName` **[string][19]** file name to save.
--   `fullPage` **[boolean][31]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `fullPage` **[boolean][31]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### scrollIntoView
 
@@ -1578,8 +1550,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 -   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][32].
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### scrollPageToBottom
 
@@ -1589,7 +1560,7 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-Returns **[Promise][21]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### scrollPageToTop
 
@@ -1599,7 +1570,7 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-Returns **[Promise][21]&lt;any>** 
+[!] returns a _promise_ which is synchronized internally by recorder
 
 ### scrollTo
 
@@ -1614,10 +1585,9 @@ I.scrollTo('#submit', 5, 5);
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][23]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][23]** (optional, `0` by default) Y-axis offset. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `offsetX` **[number][22]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][22]** (optional, `0` by default) Y-axis offset.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### see
 
@@ -1633,13 +1603,12 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 #### Parameters
 
 -   `text` **[string][19]** expected on page.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19]? | [object][18])** (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
 
@@ -1653,8 +1622,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][18]** attributes and their values to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeCheckboxIsChecked
 
@@ -1669,8 +1637,8 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][21]&lt;any>** Appium: not tested
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested
 
 ### seeCookie
 
@@ -1683,8 +1651,7 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][19]** cookie name.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeCssPropertiesOnElements
 
@@ -1698,8 +1665,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
 -   `cssProperties` **[object][18]** object with CSS properties and their values to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeCurrentUrlEquals
 
@@ -1715,8 +1681,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][19]** value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
 
@@ -1730,8 +1695,8 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1749,8 +1714,7 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInCurrentUrl
 
@@ -1763,8 +1727,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][19]** a fragment to check
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -1782,8 +1745,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][19] | [object][18])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][19]** value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
 
@@ -1805,8 +1767,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][19]** value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeInTitle
 
@@ -1819,8 +1780,7 @@ I.seeInTitle('Home Page');
 #### Parameters
 
 -   `text` **[string][19]** text value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfElements
 
@@ -1834,9 +1794,9 @@ I.seeNumberOfElements('#submitBtn', 1);
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `num` **[number][23]** number of elements.
-
-Returns **[Promise][21]&lt;any>** 
+-   `num` **[number][22]** number of elements.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1854,9 +1814,9 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `num` **[number][23]** number of elements.
-
-Returns **[Promise][21]&lt;any>** 
+-   `num` **[number][22]** number of elements.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1873,9 +1833,8 @@ I.seeTextEquals('text', 'h1');
 #### Parameters
 
 -   `text` **[string][19]** element value to check.
--   `context` **([string][19] | [object][18])?** element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `context` **([string][19] | [object][18])?** element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### seeTitleEquals
 
@@ -1888,8 +1847,7 @@ I.seeTitleEquals('Test title.');
 #### Parameters
 
 -   `text` **[string][19]** value to check.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### selectOption
 
@@ -1916,8 +1874,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][19] | [object][18])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][19] | [Array][27]&lt;any>)** visible text or value of option.
-
-Returns **[Promise][21]&lt;any>** 
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### setCookie
 
@@ -1938,9 +1895,8 @@ I.setCookie([
 #### Parameters
 
 -   `cookie` **(Cookie | [Array][27]&lt;Cookie>)** a cookie object or array of cookie objects.
-
-Returns **[Promise][21]&lt;any>** Uses Selenium's JSON [cookie
-format][33].
+    [!] returns a _promise_ which is synchronized internally by recorderUses Selenium's JSON [cookie
+    format][33].
 
 ### setGeoLocation
 
@@ -1953,11 +1909,10 @@ I.setGeoLocation(121.21, 11.56, 10);
 
 #### Parameters
 
--   `latitude` **[number][23]** to set.
--   `longitude` **[number][23]** to set
--   `altitude` **[number][23]?** (optional, null by default) to set 
-
-Returns **[Promise][21]&lt;any>** 
+-   `latitude` **[number][22]** to set.
+-   `longitude` **[number][22]** to set
+-   `altitude` **[number][22]?** (optional, null by default) to set
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### switchTo
 
@@ -1970,9 +1925,8 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `locator` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### switchToNextTab
 
@@ -1985,10 +1939,9 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` **[number][23]?** (optional) number of tabs to switch forward, default: 1. 
--   `sec` **([number][23] | null)?** (optional) time in seconds to wait. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `num` **[number][22]?** (optional) number of tabs to switch forward, default: 1. 
+-   `sec` **([number][22] | null)?** (optional) time in seconds to wait.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### switchToPreviousTab
 
@@ -2001,10 +1954,9 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` **[number][23]?** (optional) number of tabs to switch backward, default: 1. 
--   `sec` **[number][23]??** (optional) time in seconds to wait. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `num` **[number][22]?** (optional) number of tabs to switch backward, default: 1. 
+-   `sec` **[number][22]??** (optional) time in seconds to wait.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### switchToWindow
 
@@ -2044,11 +1996,10 @@ I.type(['T', 'E', 'X', 'T']);
 #### Parameters
 
 -   `keys`  
--   `delay` **[number][23]?** (optional) delay in ms between key presses 
+-   `delay` **[number][22]?** (optional) delay in ms between key presses
+    [!] returns a _promise_ which is synchronized internally by recorder 
 -   `key` **([string][19] | [Array][27]&lt;[string][19]>)** or array of keys to type.
 
-Returns **[Promise][21]&lt;any>** 
-
 ### uncheckOption
 
 Unselects a checkbox or radio button.
@@ -2065,9 +2016,9 @@ I.uncheckOption('agree', '//form');
 #### Parameters
 
 -   `field` **([string][19] | [object][18])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **[Promise][21]&lt;any>** Appium: not tested
+-   `context` **([string][19]? | [object][18])** (optional, `null` by default) element located by CSS | XPath | strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder
+    Appium: not tested 
 
 ### useWebDriverTo
 
@@ -2088,7 +2039,7 @@ I.useWebDriverTo('open multiple windows', async ({ browser }) {
 #### Parameters
 
 -   `description` **[string][19]** used to show in logs.
--   `fn` **[function][25]** async functuion that executed with WebDriver helper as argument
+-   `fn` **[function][24]** async functuion that executed with WebDriver helper as argument
 
 ### wait
 
@@ -2100,9 +2051,8 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` **[number][23]** number of second to wait.
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** number of second to wait.
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### waitForClickable
 
@@ -2118,9 +2068,8 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `waitTimeout`  
--   `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder
 
 ### waitForDetached
 
@@ -2134,9 +2083,8 @@ I.waitForDetached('#popup');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForElement
 
@@ -2151,9 +2099,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForEnabled
 
@@ -2163,9 +2110,8 @@ Element can be located by CSS or XPath.
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]** (optional) time in seconds to wait, 1 by default. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional) time in seconds to wait, 1 by default.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForFunction
 
@@ -2184,11 +2130,10 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][19] | [function][25])** to be executed in browser context.
--   `argsOrSec` **([Array][27]&lt;any> | [number][23])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `fn` **([string][19] | [function][24])** to be executed in browser context.
+-   `argsOrSec` **([Array][27]&lt;any> | [number][22])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForInvisible
 
@@ -2202,9 +2147,8 @@ I.waitForInvisible('#popup');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForText
 
@@ -2220,10 +2164,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][19]** to wait for.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
--   `context` **([string][19] | [object][18])?** (optional) element located by CSS|XPath|strict locator. 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][19] | [object][18])?** (optional) element located by CSS|XPath|strict locator.
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForValue
 
@@ -2237,9 +2180,8 @@ I.waitForValue('//input', "GoodValue");
 
 -   `field` **([string][19] | [object][18])** input field.
 -   `value` **[string][19]** expected value.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForVisible
 
@@ -2253,9 +2195,8 @@ I.waitForVisible('#popup');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitInUrl
 
@@ -2268,9 +2209,8 @@ I.waitInUrl('/info', 2);
 #### Parameters
 
 -   `urlPart` **[string][19]** value to check.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitNumberOfVisibleElements
 
@@ -2283,10 +2223,9 @@ I.waitNumberOfVisibleElements('a', 3);
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `num` **[number][23]** number of elements.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `num` **[number][22]** number of elements.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitToHide
 
@@ -2300,9 +2239,8 @@ I.waitToHide('#popup');
 #### Parameters
 
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 ### waitUrlEquals
 
@@ -2316,9 +2254,8 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 #### Parameters
 
 -   `urlPart` **[string][19]** value to check.
--   `sec` **[number][23]** (optional, `1` by default) time in seconds to wait 
-
-Returns **[Promise][21]&lt;any>** 
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait
+    [!] returns a _promise_ which is synchronized internally by recorder 
 
 [1]: http://webdriver.io/
 
@@ -2360,17 +2297,17 @@ Returns **[Promise][21]&lt;any>**
 
 [20]: http://jster.net/category/windows-modals-popups
 
-[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[21]: https://webdriver.io/docs/timeouts.html
 
-[22]: https://webdriver.io/docs/timeouts.html
+[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[23]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[23]: https://vuejs.org/v2/api/#Vue-nextTick
 
-[24]: https://vuejs.org/v2/api/#Vue-nextTick
+[24]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[25]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[25]: http://webdriver.io/api/protocol/execute.html
 
-[26]: http://webdriver.io/api/protocol/execute.html
+[26]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
 [27]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array