codeceptjs 3.3.0 → 3.3.3

package/docs/index.md

@@ -86,7 +86,7 @@ Scenario('Checkout test', ({ I }) => {
 Can we use it for long scenarios? Sure!
 
 ```js
-const faker = require('faker');                               // Use 3rd-party JS code
+const faker = require('@faker-js/faker');                               // Use 3rd-party JS code
 
 Feature('Store');
 

package/docs/locators.md

@@ -243,7 +243,7 @@ Instead of writing a full CSS locator like `[data-qa-id=user_name]` simplify it
 
 ```js
 // replace this:
-I.click({ css: '[data-test-id=register_button]');
+I.click({ css: '[data-test-id=register_button]'});
 // with this:
 I.click('$register_button');
 ```

package/docs/webapi/amOnPage.mustache

@@ -7,4 +7,5 @@ I.amOnPage('https://github.com'); // opens github
 I.amOnPage('/login'); // opens a login page
 ```
 
-@param {string} url url path or global url.
+@param {string} url url path or global url.
+@return {void} automatically synchronized promise with recorder #! 

package/docs/webapi/appendField.mustache

@@ -5,4 +5,5 @@ Field is located by name, label, CSS or XPath
 I.appendField('#myTextField', 'appended');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
-@param {string} value text value to append.
+@param {string} value text value to append.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/attachFile.mustache

@@ -8,4 +8,5 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 ```
 
 @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
-@param {string} pathToFile local file path relative to codecept.json config file.
+@param {string} pathToFile local file path relative to codecept.json config file.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/checkOption.mustache

@@ -9,4 +9,5 @@ I.checkOption('I Agree to Terms and Conditions');
 I.checkOption('agree', '//form');
 ```
 @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/clearCookie.mustache

@@ -6,4 +6,5 @@ I.clearCookie();
 I.clearCookie('test');
 ```
 
-@param {?string} [cookie=null] (optional, `null` by default) cookie name
+@param {?string} [cookie=null] (optional, `null` by default) cookie name
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/clearField.mustache

@@ -6,3 +6,4 @@ I.clearField('user[email]');
 I.clearField('#email');
 ```
 @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/click.mustache

@@ -21,4 +21,5 @@ I.click({css: 'nav a.login'});
 ```
 
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+@param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/clickLink.mustache

@@ -4,4 +4,5 @@ Performs a click on a link and waits for navigation before moving on.
 I.clickLink('Logout', '#nav');
 ```
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/closeCurrentTab.mustache

@@ -1,5 +1,7 @@
- Close current tab.
+Close current tab.
 
- ```js
- I.closeCurrentTab();
- ```
+```js
+I.closeCurrentTab();
+```
+
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/closeOtherTabs.mustache

@@ -1,6 +1,8 @@
- Close all tabs except for the current one.
+Close all tabs except for the current one.
 
 
- ```js
- I.closeOtherTabs();
- ```
+```js
+I.closeOtherTabs();
+```
+
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSee.mustache

@@ -8,3 +8,4 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 @param {string} text which is not present.
 @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCheckboxIsChecked.mustache

@@ -7,3 +7,4 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 ```
 
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCookie.mustache

@@ -4,4 +4,5 @@ Checks that cookie with given name does not exist.
 I.dontSeeCookie('auth'); // no auth cookie
 ```
 
-@param {string} name cookie name.
+@param {string} name cookie name.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCurrentUrlEquals.mustache

@@ -6,4 +6,5 @@ I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
 I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
 ```
 
-@param {string} url value to check.
+@param {string} url value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeElement.mustache

@@ -4,4 +4,5 @@ Opposite to `seeElement`. Checks that element is not visible (or in DOM)
 I.dontSeeElement('.modal'); // modal is not shown
 ```
 
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeElementInDOM.mustache

@@ -4,4 +4,5 @@ Opposite to `seeElementInDOM`. Checks that element is not on page.
 I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
 ```
 
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInCurrentUrl.mustache

@@ -1,3 +1,4 @@
 Checks that current url does not contain a provided fragment.
 
-@param {string} url value to check.
+@param {string} url value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInField.mustache

@@ -7,4 +7,5 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 ```
 
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value value to check.
+@param {string} value value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInSource.mustache

@@ -5,3 +5,4 @@ I.dontSeeInSource('<!--'); // no comments in source
 ```
 
 @param {string} value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInTitle.mustache

@@ -4,4 +4,5 @@ Checks that title does not contain text.
 I.dontSeeInTitle('Error');
 ```
 
-@param {string} text value to check.
+@param {string} text value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/doubleClick.mustache

@@ -10,3 +10,4 @@ I.doubleClick('.btn.edit');
 
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/downloadFile.mustache

@@ -8,4 +8,5 @@ I.downloadFile('td[class="text-right file-link"] a', 'thisIsCustomName');
 ```
 
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by CSS|XPath locator.
-@param {string} file custom file name.
+@param {string} file custom file name.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dragAndDrop.mustache

@@ -6,3 +6,4 @@ I.dragAndDrop('#dragHandle', '#container');
 
 @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
 @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dragSlider.mustache

@@ -7,4 +7,5 @@ I.dragSlider('#slider', -70);
 ```
 
 @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
-@param {number} offsetX position to drag.
+@param {number} offsetX position to drag.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/executeAsyncScript.mustache

@@ -21,4 +21,4 @@ let val = await I.executeAsyncScript(function(url, done) {
 
 @param {string|function} fn function to be executed in browser context.
 @param {...any} args to be passed to function.
-@return {Promise<any>}
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/executeScript.mustache

@@ -23,4 +23,4 @@ let date = await I.executeScript(function(el) {
 
 @param {string|function} fn function to be executed in browser context.
 @param {...any} args to be passed to function.
-@return {Promise<any>}
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/fillField.mustache

@@ -13,3 +13,4 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {CodeceptJS.StringOrSecret} value text value to fill.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/forceClick.mustache

@@ -25,3 +25,4 @@ I.forceClick({css: 'nav a.login'});
 
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/forceRightClick.mustache

@@ -15,3 +15,4 @@ I.forceRightClick('Menu');
 
 @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/grabDataFromPerformanceTiming.mustache

@@ -16,4 +16,5 @@ let data = await I.grabDataFromPerformanceTiming();
   domContentLoadedEventEnd: 196,
   loadEventEnd: 241
 }
-```
+```
+@return {Promise<any>} automatically synchronized promise through #recorder 

package/docs/webapi/moveCursorTo.mustache

@@ -9,3 +9,4 @@ I.moveCursorTo('#submit', 5,5);
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
 @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/openNewTab.mustache

@@ -1,5 +1,7 @@
- Open new tab and switch to it.
+Open new tab and switch to it.
 
- ```js
- I.openNewTab();
- ```
+```js
+I.openNewTab();
+```
+
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/pressKey.mustache

@@ -8,4 +8,5 @@ I.pressKey('Enter');
 I.pressKey(['Control','a']);
 ```
 
-@param {string|string[]} key key or array of keys to press.
+@param {string|string[]} key key or array of keys to press.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/pressKeyDown.mustache

@@ -9,3 +9,4 @@ I.pressKeyUp('Control');
 ```
 
 @param {string} key name of key to press down.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/pressKeyUp.mustache

@@ -9,3 +9,4 @@ I.pressKeyUp('Control');
 ```
 
 @param {string} key name of key to release.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/pressKeyWithKeyNormalization.mustache

@@ -57,3 +57,4 @@ Some of the supported key names are:
 - `'Tab'`
 
 @param {string|string[]} key key or array of keys to press.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/refreshPage.mustache

@@ -3,3 +3,4 @@ Reload the current page.
 ```js
 I.refreshPage();
 ```
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/resizeWindow.mustache

@@ -2,4 +2,5 @@ Resize the current window to provided width and height.
 First parameter can be set to `maximize`.
 
 @param {number} width width in pixels or `maximize`.
-@param {number} height height in pixels.
+@param {number} height height in pixels.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/rightClick.mustache

@@ -11,3 +11,4 @@ I.rightClick('Click me', '.context');
 
 @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/saveElementScreenshot.mustache

@@ -7,3 +7,4 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {string} fileName file name to save.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/saveScreenshot.mustache

@@ -8,4 +8,5 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 ```
 
 @param {string} fileName file name to save.
-@param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+@param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/say.mustache

@@ -6,4 +6,5 @@ I.say('This is blue', 'blue'); //blue is used
 I.say('This is by default'); //cyan is used
 ```
 @param {string} text expected on console log.
-@param {string} [color='cyan'] color you want to use.
+@param {string} [color='cyan'] color you want to use.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/scrollIntoView.mustache

@@ -8,3 +8,4 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 
 @param {LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/scrollPageToBottom.mustache

@@ -3,3 +3,4 @@ Scroll page to the bottom.
 ```js
 I.scrollPageToBottom();
 ```
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/scrollPageToTop.mustache

@@ -3,3 +3,4 @@ Scroll page to the top.
 ```js
 I.scrollPageToTop();
 ```
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/scrollTo.mustache

@@ -8,4 +8,5 @@ I.scrollTo('#submit', 5, 5);
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
-@param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
+@param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/see.mustache

@@ -7,4 +7,5 @@ I.see('Welcome', '.content'); // text inside .content div
 I.see('Register', {css: 'form.register'}); // use strict locator
 ```
 @param {string} text expected on page.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+@param {?CodeceptJS.LocatorOrString} [context=null] (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

package/docs/webapi/seeAttributesOnElements.mustache

@@ -5,4 +5,5 @@ I.seeAttributesOnElements('//form', { method: "post"});
 ```
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {object} attributes attributes and their values to check.
+@param {object} attributes attributes and their values to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeCheckboxIsChecked.mustache

@@ -7,3 +7,4 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 ```
 
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeCookie.mustache

@@ -5,3 +5,4 @@ I.seeCookie('Auth');
 ```
 
 @param {string} name cookie name.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeCssPropertiesOnElements.mustache

@@ -5,4 +5,5 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 ```
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {object} cssProperties object with CSS properties and their values to check.
+@param {object} cssProperties object with CSS properties and their values to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeCurrentUrlEquals.mustache

@@ -7,4 +7,5 @@ I.seeCurrentUrlEquals('/register');
 I.seeCurrentUrlEquals('http://my.site.com/register');
 ```
 
-@param {string} url value to check.
+@param {string} url value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeElement.mustache

@@ -4,4 +4,5 @@ Element is located by CSS or XPath.
 ```js
 I.seeElement('#modal');
 ```
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeElementInDOM.mustache

@@ -5,3 +5,4 @@ Element is located by CSS or XPath.
 I.seeElementInDOM('#modal');
 ```
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeInCurrentUrl.mustache

@@ -4,4 +4,5 @@ Checks that current url contains a provided fragment.
 I.seeInCurrentUrl('/register'); // we are on registration page
 ```
 
-@param {string} url a fragment to check
+@param {string} url a fragment to check
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeInField.mustache

@@ -9,3 +9,4 @@ I.seeInField('#searchform input','Search');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {string} value value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeInPopup.mustache

@@ -5,3 +5,4 @@ given string.
 I.seeInPopup('Popup text');
 ```
 @param {string} text value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeInSource.mustache

@@ -3,4 +3,5 @@ Checks that the current page contains the given string in its raw source code.
 ```js
 I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 ```
-@param {string} text value to check.
+@param {string} text value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeInTitle.mustache

@@ -4,4 +4,5 @@ Checks that title contains text.
 I.seeInTitle('Home Page');
 ```
 
-@param {string} text text value to check.
+@param {string} text text value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeNumberOfElements.mustache

@@ -8,3 +8,4 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeNumberOfVisibleElements.mustache

@@ -7,3 +7,4 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeTextEquals.mustache

@@ -5,4 +5,5 @@ I.seeTextEquals('text', 'h1');
 ```
 
 @param {string} text element value to check.
-@param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/seeTitleEquals.mustache

@@ -1,7 +1,8 @@
- Checks that title is equal to provided one.
+Checks that title is equal to provided one.
 
- ```js
- I.seeTitleEquals('Test title.');
- ```
+```js
+I.seeTitleEquals('Test title.');
+```
 
- @param {string} text value to check.
+@param {string} text value to check.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/selectOption.mustache

@@ -18,3 +18,4 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 ```
 @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
 @param {string|Array<*>} option visible text or value of option.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/setCookie.mustache

@@ -13,3 +13,4 @@ I.setCookie([
 ```
 
 @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/setGeoLocation.mustache

@@ -9,3 +9,4 @@ I.setGeoLocation(121.21, 11.56, 10);
 @param {number} latitude to set.
 @param {number} longitude to set
 @param {number=} altitude (optional, null by default) to set
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/switchTo.mustache

@@ -5,4 +5,5 @@ I.switchTo('iframe'); // switch to first iframe
 I.switchTo(); // switch back to main page
 ```
 
-@param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
+@param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/switchToNextTab.mustache

@@ -1,9 +1,10 @@
- Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
 
- ```js
- I.switchToNextTab();
- I.switchToNextTab(2);
- ```
+```js
+I.switchToNextTab();
+I.switchToNextTab(2);
+```
 
- @param {number} [num] (optional) number of tabs to switch forward, default: 1.
- @param {number | null} [sec] (optional) time in seconds to wait.
+@param {number} [num] (optional) number of tabs to switch forward, default: 1.
+@param {number | null} [sec] (optional) time in seconds to wait.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/switchToPreviousTab.mustache

@@ -1,9 +1,10 @@
- Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
+Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
 
- ```js
- I.switchToPreviousTab();
- I.switchToPreviousTab(2);
- ```
+```js
+I.switchToPreviousTab();
+I.switchToPreviousTab(2);
+```
 
- @param {number} [num] (optional) number of tabs to switch backward, default: 1.
- @param {number?} [sec] (optional) time in seconds to wait.
+@param {number} [num] (optional) number of tabs to switch backward, default: 1.
+@param {number?} [sec] (optional) time in seconds to wait.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/type.mustache

@@ -15,3 +15,4 @@ I.type(['T', 'E', 'X', 'T']);
 
 @param {string|string[]} key or array of keys to type.
 @param {?number} [delay=null] (optional) delay in ms between key presses
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/uncheckOption.mustache

@@ -9,4 +9,5 @@ I.uncheckOption('I Agree to Terms and Conditions');
 I.uncheckOption('agree', '//form');
 ```
 @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/wait.mustache

@@ -4,4 +4,5 @@ Pauses execution for a number of seconds.
 I.wait(2); // wait 2 secs
 ```
 
-@param {number} sec number of second to wait.
+@param {number} sec number of second to wait.
+[!] returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/waitForClickable.mustache

@@ -7,4 +7,5 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 ```
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
+@param {number} [sec] (optional, `1` by default) time in seconds to wait
+[!] returns a _promise_ which is synchronized internally by recorder