codeceptjs 2.3.4 → 2.4.1

package/docs/build/WebDriverIO.js

@@ -1,5 +1,9 @@
 let webdriverio;
+
+const assert = require('assert');
+const path = require('path');
 const requireg = require('requireg');
+
 const Helper = require('../helper');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
@@ -21,8 +25,6 @@ const {
 const ElementNotFound = require('./errors/ElementNotFound');
 const ConnectionRefused = require('./errors/ConnectionRefused');
 
-const assert = require('assert');
-const path = require('path');
 
 const webRoot = 'body';
 const Locator = require('../locator');
@@ -92,7 +94,7 @@ let withinStore = {};
  *        "browser": "chrome",
  *        "desiredCapabilities": {
  *          "chromeOptions": {
- *            "args": [ "--headless", "--disable-gpu", "--window-size=800,600" ]
+ *            "args": [ "--headless", "--disable-gpu", "--no-sandbox" ]
  *          }
  *        }
  *      }
@@ -446,7 +448,7 @@ class WebDriverIO extends Helper {
    * this.helpers['WebDriverIO']._locate({name: 'password'}).then //...
    * ```
    *
-   * @param locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locate(locator, smartWait = false) {
     if (!this.options.smartWait || !smartWait) return this.browser.elements(withStrictLocator.call(this, locator));
@@ -465,7 +467,7 @@ class WebDriverIO extends Helper {
    * this.helpers['WebDriverIO']._locateCheckable('I agree with terms and conditions').then // ...
    * ```
    *
-   * @param locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateCheckable(locator) {
     return findCheckable.call(this, locator, this.browser.elements.bind(this)).then(res => res.value);
@@ -478,7 +480,7 @@ class WebDriverIO extends Helper {
    * this.helpers['WebDriverIO']._locateClickable('Next page').then // ...
    * ```
    *
-   * @param locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateClickable(locator) {
     return findClickable.call(this, locator, this.browser.elements.bind(this)).then(res => res.value);
@@ -491,7 +493,7 @@ class WebDriverIO extends Helper {
    * this.helpers['WebDriverIO']._locateFields('Your email').then // ...
    * ```
    *
-   * @param locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    */
   async _locateFields(locator) {
     return findFields.call(this, locator).then(res => res.value);
@@ -507,7 +509,7 @@ class WebDriverIO extends Helper {
    * I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
    * ```
    *
-   * @param timeouts WebDriver timeouts object.
+   * @param {WebdriverIO.Timeouts}  timeouts WebDriver timeouts object.
    */
   async defineTimeout(timeouts) {
     try {
@@ -543,7 +545,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
-   * {--end--}
    * Appium: support only web testing
    */
   amOnPage(url) {
@@ -573,9 +574,9 @@ class WebDriverIO extends Helper {
    * I.click({css: 'nav a.login'});
    * ```
    * 
-   * @param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * {--end--}
+   * @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.
+   * 
    * Appium: support
    */
   async click(locator, context = null) {
@@ -602,9 +603,9 @@ class WebDriverIO extends Helper {
    * I.doubleClick('.btn.edit');
    * ```
    * 
-   * @param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * {--end--}
+   * @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.
+   * 
    * Appium: support only web testing
    */
   async doubleClick(locator, context = null) {
@@ -634,9 +635,9 @@ class WebDriverIO extends Helper {
    * I.rightClick('Click me', '.context');
    * ```
    * 
-   * @param {string|object} locator clickable element located by CSS|XPath|strict locator.
-   * @param {string|object} context (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * {--end--}
+   * @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.
+   * 
    * Appium: support, but in apps works as usual click
    */
   async rightClick(locator) {
@@ -666,9 +667,9 @@ class WebDriverIO extends Helper {
    * // or by strict locator
    * I.fillField({css: 'form#login input[name=username]'}, 'John');
    * ```
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value text value to fill.
-   * {--end--}
+   * 
    * Appium: support
    */
   async fillField(field, value) {
@@ -685,9 +686,8 @@ class WebDriverIO extends Helper {
    * ```js
    * I.appendField('#myTextField', 'appended');
    * ```
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
-   * {--end--}
    * Appium: support, but it's clear a field before insert in apps
    */
   async appendField(field, value) {
@@ -751,9 +751,8 @@ class WebDriverIO extends Helper {
    * I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
    * ```
    * 
-   * @param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+   * @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.
-   * {--end--}
    * Appium: not tested
    */
   async attachFile(locator, pathToFile) {
@@ -780,9 +779,8 @@ class WebDriverIO extends Helper {
    * I.checkOption('I Agree to Terms and Conditions');
    * I.checkOption('agree', '//form');
    * ```
-   * @param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
-   * @param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
-   * {--end--}
+   * @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.
    * Appium: not tested
    */
   async checkOption(field, context = null) {
@@ -810,9 +808,8 @@ class WebDriverIO extends Helper {
    * I.uncheckOption('I Agree to Terms and Conditions');
    * I.uncheckOption('agree', '//form');
    * ```
-   * @param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
-   * @param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
-   * {--end--}
+   * @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.
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
@@ -838,9 +835,8 @@ class WebDriverIO extends Helper {
    * ```
    * If multiple elements found returns an array of texts.
    * 
-   * @param locator element located by CSS|XPath|strict locator.
-   * @returns {Promise<string>} attribute value
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @returns {Promise<string|string[]>} attribute value
    * Appium: support
    */
   async grabTextFrom(locator) {
@@ -860,9 +856,8 @@ class WebDriverIO extends Helper {
    * let postHTML = await I.grabHTMLFrom('#post');
    * ```
    * 
-   * @param locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
    * @returns {Promise<string>} HTML code for an element
-   * {--end--}
    * Appium: support only web testing
    */
   async grabHTMLFrom(locator) {
@@ -878,9 +873,8 @@ class WebDriverIO extends Helper {
    * ```js
    * let email = await I.grabValueFrom('input[name=email]');
    * ```
-   * @param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
    * @returns {Promise<string>} attribute value
-   * {--end--}
    * Appium: support only web testing
    */
   async grabValueFrom(locator) {
@@ -898,10 +892,9 @@ class WebDriverIO extends Helper {
    * const value = await I.grabCssPropertyFrom('h3', 'font-weight');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} cssProperty CSS property name.
    * @returns {Promise<string>} CSS value
-   * {--end--}
    */
   async grabCssPropertyFrom(locator, cssProperty) {
     const res = await this._locate(locator, true);
@@ -917,10 +910,9 @@ class WebDriverIO extends Helper {
    * ```js
    * let hint = await I.grabAttributeFrom('#tooltip', 'title');
    * ```
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} attr attribute name.
    * @returns {Promise<string>} attribute value
-   * {--end--}
    * Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
    */
   async grabAttributeFrom(locator, attr) {
@@ -937,7 +929,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async seeInTitle(text) {
@@ -952,7 +943,7 @@ class WebDriverIO extends Helper {
    * I.seeTitleEquals('Test title.');
    * ```
    *
-   * @param text value to check.
+   * @param {string} text value to check.
    */
   async seeTitleEquals(text) {
     const title = await this.browser.getTitle();
@@ -967,7 +958,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} text value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async dontSeeInTitle(text) {
@@ -984,7 +974,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @returns {Promise<string>} title
-   * {--end--}
    * Appium: support only web testing
    */
   async grabTitle() {
@@ -1003,8 +992,7 @@ class WebDriverIO extends Helper {
    * I.see('Register', {css: 'form.register'}); // use strict locator
    * ```
    * @param {string} text expected on page.
-   * @param {string|object} context (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-   * {--end--}
+   * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
    * Appium: support with context in apps
    */
   async see(text, context = null) {
@@ -1018,8 +1006,8 @@ class WebDriverIO extends Helper {
    * I.seeTextEquals('text', 'h1');
    * ```
    *
-   * @param text element value to check.
-   * @param context (optional) element located by CSS|XPath|strict locator.
+   * @param {string} text element value to check.
+   * @param {CodeceptJS.LocatorOrString?} [context] (optional) element located by CSS|XPath|strict locator.
    */
   async seeTextEquals(text, context = null) {
     return proceedSee.call(this, 'assert', text, context, true);
@@ -1035,9 +1023,8 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} text which is not present.
-   * @param {string|object} context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   *
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+   * 
    * Appium: support with context in apps
    */
   async dontSee(text, context = null) {
@@ -1054,9 +1041,9 @@ class WebDriverIO extends Helper {
    * I.seeInField('form input[type=hidden]','hidden_value');
    * I.seeInField('#searchform input','Search');
    * ```
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * {--end--}
+   * 
    * Appium: support only web testing
    */
   async seeInField(field, value) {
@@ -1072,9 +1059,8 @@ class WebDriverIO extends Helper {
    * I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
    * ```
    * 
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async dontSeeInField(field, value) {
@@ -1090,8 +1076,8 @@ class WebDriverIO extends Helper {
    * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
    * ```
    * 
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * 
    * Appium: not tested
    */
   async seeCheckboxIsChecked(field) {
@@ -1107,8 +1093,8 @@ class WebDriverIO extends Helper {
    * I.dontSeeCheckboxIsChecked('agree'); // located by name
    * ```
    * 
-   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * 
    * Appium: not tested
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1122,8 +1108,7 @@ class WebDriverIO extends Helper {
    * ```js
    * I.seeElement('#modal');
    * ```
-   * @param {string|object} locator located by CSS|XPath|strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * Appium: support
    */
   async seeElement(locator) {
@@ -1156,8 +1141,8 @@ class WebDriverIO extends Helper {
    * ```js
    * I.seeElementInDOM('#modal');
    * ```
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * 
    * Appium: support
    */
   async seeElementInDOM(locator) {
@@ -1172,8 +1157,7 @@ class WebDriverIO extends Helper {
    * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|Strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
    * Appium: support
    */
   async dontSeeElementInDOM(locator) {
@@ -1188,7 +1172,6 @@ class WebDriverIO extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * {--end--}
    * Appium: support
    */
   async seeInSource(text) {
@@ -1205,7 +1188,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @returns {Promise<string>} source code
-   * {--end--}
    * Appium: support
    */
   async grabSource() {
@@ -1234,7 +1216,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @returns {Promise<string>} current URL
-   * {--end--}
    */
   async grabCurrentUrl() {
     const res = await this.browser.url();
@@ -1255,7 +1236,7 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * {--end--}
+   * 
    * Appium: support
    */
   async dontSeeInSource(text) {
@@ -1272,8 +1253,8 @@ class WebDriverIO extends Helper {
    * I.seeNumberOfElements('#submitBtn', 1);
    * ```
    *
-   * @param locator element located by CSS|XPath|strict locator.
-   * @param num number of elements.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [num] number of elements.
    */
   async seeNumberOfElements(locator, num) {
     const res = await this._locate(withStrictLocator.call(this, locator));
@@ -1288,9 +1269,9 @@ class WebDriverIO extends Helper {
    * I.seeNumberOfVisibleElements('.buttons', 3);
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * {--end--}
+   * 
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
@@ -1304,9 +1285,8 @@ class WebDriverIO extends Helper {
    * I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} cssProperties object with CSS properties and their values to check.
-   * {--end--}
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
     const res = await this._locate(locator);
@@ -1347,9 +1327,8 @@ class WebDriverIO extends Helper {
    * I.seeAttributesOnElements('//form', { method: "post"});
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {object} attributes attributes and their values to check.
-   * {--end--}
    */
   async seeAttributesOnElements(locator, attributes) {
     const res = await this._locate(locator);
@@ -1382,9 +1361,8 @@ class WebDriverIO extends Helper {
    * let numOfElements = await I.grabNumberOfVisibleElements('p');
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
    * @returns {Promise<number>} number of visible elements
-   * {--end--}
    */
   async grabNumberOfVisibleElements(locator) {
     const res = await this._locate(locator);
@@ -1403,7 +1381,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * {--end--}
    * Appium: support only web testing
    */
   async seeInCurrentUrl(url) {
@@ -1415,7 +1392,6 @@ class WebDriverIO extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async dontSeeInCurrentUrl(url) {
@@ -1434,7 +1410,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async seeCurrentUrlEquals(url) {
@@ -1452,7 +1427,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    * Appium: support only web testing
    */
   async dontSeeCurrentUrlEquals(url) {
@@ -1485,8 +1459,9 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string|function} fn function to be executed in browser context.
-   * @param ...args args to be passed to function.
-   * {--end--}
+   * @param {...any} args to be passed to function.
+   * @return {Promise<any>}
+   * 
    * Appium: support only web testing
    *
    * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
@@ -1518,8 +1493,9 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string|function} fn function to be executed in browser context.
-   * @param ...args args to be passed to function.
-   * {--end--}
+   * @param {...any} args to be passed to function.
+   * @return {Promise<any>}
+   * 
    * Appium: support only web testing
    */
   executeAsyncScript(fn) {
@@ -1535,9 +1511,9 @@ class WebDriverIO extends Helper {
    * I.scrollTo('#submit', 5, 5);
    * ```
    *
-   * @param locator located by CSS|XPath|strict locator.
-   * @param offsetX (optional) X-axis offset.
-   * @param offsetY (optional) Y-axis offset.
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @param {number} [offsetX=0] (optional) X-axis offset.
+   * @param {number} [offsetY=0] (optional) Y-axis offset.
    */
 
   /**
@@ -1549,10 +1525,9 @@ class WebDriverIO extends Helper {
    * I.scrollTo('#submit', 5, 5);
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|strict locator.
-   * @param {number} offsetX (optional, `0` by default) X-axis offset.
-   * @param {number} offsetY (optional, `0` by default) Y-axis offset.
-   * {--end--}
+   * @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.
    * Appium: support only web testing
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
@@ -1584,7 +1559,18 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * {{> moveCursorTo}}
+   * Moves cursor to element matched by locator.
+   * Extra shift can be set with offsetX and offsetY options.
+   * 
+   * ```js
+   * I.moveCursorTo('.tooltip');
+   * 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.
+   * 
    * Appium: support only web testing
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
@@ -1658,7 +1644,15 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * {{> clearCookie}}
+   * Clears a cookie by name,
+   * if none provided clears all cookies.
+   * 
+   * ```js
+   * I.clearCookie();
+   * I.clearCookie('test');
+   * ```
+   * 
+   * @param {?string} [cookie=null] (optional, `null` by default) cookie name
    * Appium: support only web testing
    */
   async clearCookie(cookie) {
@@ -1666,7 +1660,14 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * {{> seeCookie}}
+   * Checks that cookie with given name exists.
+   * 
+   * ```js
+   * I.seeCookie('Auth');
+   * ```
+   * 
+   * @param {string} name cookie name.
+   * 
    * Appium: support only web testing
    */
   async seeCookie(name) {
@@ -1675,7 +1676,13 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * {{> dontSeeCookie}}
+   * Checks that cookie with given name does not exist.
+   * 
+   * ```js
+   * I.dontSeeCookie('auth'); // no auth cookie
+   * ```
+   * 
+   * @param {string} name cookie name.
    * Appium: support only web testing
    */
   async dontSeeCookie(name) {
@@ -1684,7 +1691,17 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * {{> grabCookie}}
+   * Gets a cookie object by name.
+   * If none provided gets all cookies.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let cookie = await I.grabCookie('auth');
+   * assert(cookie.value, '123456');
+   * ```
+   * 
+   * @param {?string} [name=null] cookie name.
+   * @returns {Promise<string>} attribute value
    * Appium: support only web testing
    */
   async grabCookie(name) {
@@ -1720,7 +1737,7 @@ class WebDriverIO extends Helper {
    * Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
    * given string. Appium: support only web testing
    *
-   * @param text value to check.
+   * @param {string} text value to check.
    */
   async seeInPopup(text) {
     return this.browser.alertText().then((res) => {
@@ -1744,28 +1761,66 @@ class WebDriverIO extends Helper {
   }
 
   /**
-   * Presses a key on a focused element.
-   * Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
-   * will be replaced with corresponding unicode.
-   * If modifier key is used (Control, Command, Alt, Shift) in array, it will be released afterwards.
+   * Presses a key in the browser (on a focused element).
+   * 
+   * _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
    * 
    * ```js
-   * I.pressKey('Enter');
-   * I.pressKey(['Control','a']);
+   * I.pressKey('Backspace');
    * ```
    * 
-   * @param {string|array} key key or array of keys to press.
-   * {--end--}
-   * {{> _keys }}
-   *
-   * To make combinations with modifier and mouse clicks (like Ctrl+Click) press a modifier, click, then release it.
-   * Appium: support, but clear field before pressing in apps:
-   *
+   * To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys (`'Alt'`, `'Control'`, `'Meta'`, `'Shift'`) will be released afterwards.
+   * 
+   * ```js
+   * I.pressKey(['Control', 'Z']);
+   * ```
+   * 
+   * For specifying operation modifier key based on operating system it is suggested to use `'CommandOrControl'`.
+   * This will press `'Command'` (also known as `'Meta'`) on macOS machines and `'Control'` on non-macOS machines.
+   * 
    * ```js
-   * I.pressKey('Control');
-   * I.click('#someelement');
-   * I.pressKey('Control');
+   * I.pressKey(['CommandOrControl', 'Z']);
    * ```
+   * 
+   * Some of the supported key names are:
+   * - `'AltLeft'` or `'Alt'`
+   * - `'AltRight'`
+   * - `'ArrowDown'`
+   * - `'ArrowLeft'`
+   * - `'ArrowRight'`
+   * - `'ArrowUp'`
+   * - `'Backspace'`
+   * - `'Clear'`
+   * - `'ControlLeft'` or `'Control'`
+   * - `'ControlRight'`
+   * - `'Command'`
+   * - `'CommandOrControl'`
+   * - `'Delete'`
+   * - `'End'`
+   * - `'Enter'`
+   * - `'Escape'`
+   * - `'F1'` to `'F12'`
+   * - `'Home'`
+   * - `'Insert'`
+   * - `'MetaLeft'` or `'Meta'`
+   * - `'MetaRight'`
+   * - `'Numpad0'` to `'Numpad9'`
+   * - `'NumpadAdd'`
+   * - `'NumpadDecimal'`
+   * - `'NumpadDivide'`
+   * - `'NumpadMultiply'`
+   * - `'NumpadSubtract'`
+   * - `'PageDown'`
+   * - `'PageUp'`
+   * - `'Pause'`
+   * - `'Return'`
+   * - `'ShiftLeft'` or `'Shift'`
+   * - `'ShiftRight'`
+   * - `'Space'`
+   * - `'Tab'`
+   * 
+   * @param {string|string[]} key key or array of keys to press.
+   * 
    */
   async pressKey(key) {
     let modifier;
@@ -1784,7 +1839,6 @@ class WebDriverIO extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * {--end--}
    * Appium: not tested in web, in apps doesn't work
    */
   async resizeWindow(width, height) {
@@ -1813,7 +1867,6 @@ class WebDriverIO extends Helper {
    * 
    * @param {string|object} srcElement located by CSS|XPath|strict locator.
    * @param {string|object} destElement located by CSS|XPath|strict locator.
-   * {--end--}
    * Appium: not tested
    */
   async dragAndDrop(srcElement, destElement) {
@@ -1879,7 +1932,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * {--end--}
    * Appium: support
    */
   async wait(sec) {
@@ -1890,9 +1942,8 @@ class WebDriverIO extends Helper {
    * Waits for element to become enabled (by default waits for 1sec).
    * Element can be located by CSS or XPath.
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param sec (optional) time in seconds to wait, 1 by default.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
    * Appium: support
    */
   async waitForEnabled(locator, sec = null) {
@@ -1920,9 +1971,8 @@ class WebDriverIO extends Helper {
    * I.waitForElement('.btn.continue', 5); // wait for 5 secs
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec] (optional, `1` by default) time in seconds to wait
    * Appium: support
    */
   async waitForElement(locator, sec = null) {
@@ -1949,8 +1999,7 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} urlPart value to check.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    */
   async waitInUrl(urlPart, sec = null) {
     const client = this.browser;
@@ -1980,8 +2029,7 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string} urlPart value to check.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    */
   async waitUrlEquals(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2015,9 +2063,8 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string }text to wait for.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * @param {string|object} context (optional) element located by CSS|XPath|strict locator.
-   * {--end--}
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
    * Appium: support
    */
   async waitForText(text, sec = null, context = null) {
@@ -2046,8 +2093,7 @@ class WebDriverIO extends Helper {
    * 
    * @param {string|object} field input field.
    * @param {string }value expected value.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    */
   async waitForValue(field, value, sec = null) {
     const client = this.browser;
@@ -2074,9 +2120,8 @@ class WebDriverIO extends Helper {
    * I.waitForVisible('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * Appium: support
    */
   async waitForVisible(locator, sec = null) {
@@ -2099,10 +2144,9 @@ class WebDriverIO extends Helper {
    * I.waitNumberOfVisibleElements('a', 3);
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2124,9 +2168,8 @@ class WebDriverIO extends Helper {
    * I.waitForInvisible('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * Appium: support
    */
   async waitForInvisible(locator, sec = null) {
@@ -2150,9 +2193,8 @@ class WebDriverIO extends Helper {
    * I.waitToHide('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * Appium: support
    */
   async waitToHide(locator, sec = null) {
@@ -2172,9 +2214,8 @@ class WebDriverIO extends Helper {
    * I.waitForDetached('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * Appium: support
    */
   async waitForDetached(locator, sec = null) {
@@ -2203,9 +2244,9 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {string|function} fn to be executed in browser context.
-   * @param {array|number} argsOrSec (optional, `1` by default) arguments for function or seconds.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
+   * @param {number} [sec] (optional, `1` by default) time in seconds to wait
+   * 
    * Appium: support
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
@@ -2232,10 +2273,9 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @param {function|string} fn function which is executed in browser context.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * @param {string} [timeoutMsg=''] message to show in case of timeout fail.
-   * {--end--}
-   * @param interval (optional) time in seconds between condition checks.
+   * @param {?number} [interval=null]
    * * *Appium*: supported
    */
   async waitUntil(fn, sec = null, timeoutMsg = null, interval = null) {
@@ -2252,16 +2292,17 @@ class WebDriverIO extends Helper {
    * I.switchTo(); // switch back to main page
    * ```
    * 
-   * @param {string|object} locator (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * {--end--}
+   * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
    * Appium: support only web testing
    */
   async switchTo(locator) {
     if (Number.isInteger(locator)) {
       return this.browser.frame(locator);
-    } else if (!locator) {
+    }
+    if (!locator) {
       return this.browser.frame(null);
     }
+
     const res = await this._locate(withStrictLocator.call(this, locator), true);
     assertElementExists(res, locator);
     return this.browser.frame(res.value[0]);
@@ -2275,8 +2316,8 @@ class WebDriverIO extends Helper {
    * I.switchToNextTab(2);
    * ```
    *
-   * @param num (optional) number of tabs to switch forward, default: 1.
-   * @param sec (optional) time in seconds to wait.
+   * @param {number} [num=1] (optional) number of tabs to switch forward, default: 1.
+   * @param {?number} [sec=null] (optional) time in seconds to wait.
    */
   async switchToNextTab(num = 1, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2301,8 +2342,8 @@ class WebDriverIO extends Helper {
    * I.switchToPreviousTab(2);
    * ```
    *
-   * @param num (optional) number of tabs to switch backward, default: 1.
-   * @param sec (optional) time in seconds to wait.
+   * @param {number} [num=1] (optional) number of tabs to switch backward, default: 1.
+   * @param {?number} [sec] (optional) time in seconds to wait.
    */
   async switchToPreviousTab(num = 1, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2350,7 +2391,6 @@ class WebDriverIO extends Helper {
    * ```
    * 
    * @returns {Promise<number>} number of open tabs
-   * {--end--}
    */
   async grabNumberOfOpenTabs() {
     const pages = await this.browser.getTabIds();
@@ -2363,7 +2403,7 @@ class WebDriverIO extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * {--end--}
+   * 
    */
   async refreshPage() {
     const client = this.browser;
@@ -2376,7 +2416,7 @@ class WebDriverIO extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * {--end--}
+   * 
    */
   scrollPageToTop() {
     const client = this.browser;
@@ -2393,7 +2433,7 @@ class WebDriverIO extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * {--end--}
+   * 
    */
   scrollPageToBottom() {
     const client = this.browser;
@@ -2492,16 +2532,11 @@ async function forEachAsync(array, callback, option = {}) {
   const inputArray = Array.isArray(array) ? array : [array];
   const values = [];
   for (let index = 0; index < inputArray.length; index++) {
-    let res;
-    try {
-      res = await callback(inputArray[index], index, inputArray);
-      if (Array.isArray(res) && expandArrayResults) {
-        res.forEach(val => values.push(val));
-      } else if (res) {
-        values.push(res);
-      }
-    } catch (err) {
-      throw err;
+    const res = await callback(inputArray[index], index, inputArray);
+    if (Array.isArray(res) && expandArrayResults) {
+      res.forEach(val => values.push(val));
+    } else if (res) {
+      values.push(res);
     }
   }
   if (unifyResults) {
@@ -2525,15 +2560,11 @@ async function filterAsync(array, callback, option = {}) {
   const inputArray = Array.isArray(array) ? array : [array];
   const values = [];
   for (let index = 0; index < inputArray.length; index++) {
-    try {
-      const res = unify(await callback(inputArray[index], index, inputArray), { extractValue });
-      const value = Array.isArray(res) ? res[0] : res;
+    const res = unify(await callback(inputArray[index], index, inputArray), { extractValue });
+    const value = Array.isArray(res) ? res[0] : res;
 
-      if (value) {
-        values.push(inputArray[index]);
-      }
-    } catch (err) {
-      throw err;
+    if (value) {
+      values.push(inputArray[index]);
     }
   }
   return values;
@@ -2543,8 +2574,8 @@ async function filterAsync(array, callback, option = {}) {
 // Internal helper method to handle command results (similar behaviour as the unify function from WebDriverIO
 // except it does not resolve promises)
 //
-// @param  {object[]} items  list of items
-// @param  {object} [option]  extractValue: set to try to return the .value property of the input items
+// @param {object[]} items  list of items
+// @param {object} [option]  extractValue: set to try to return the .value property of the input items
 function unify(items, option = {}) {
   const { extractValue = false } = option;