codeceptjs 2.3.4 → 2.4.1

package/docs/build/Protractor.js

@@ -4,7 +4,9 @@ let Button;
 let ProtractorBy;
 let ProtractorExpectedConditions;
 
+const path = require('path');
 const requireg = require('requireg');
+
 const Helper = require('../helper');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
@@ -23,7 +25,6 @@ const {
 const ElementNotFound = require('./errors/ElementNotFound');
 const ConnectionRefused = require('./errors/ConnectionRefused');
 const Locator = require('../locator');
-const path = require('path');
 
 let withinStore = {};
 let Runner;
@@ -99,7 +100,7 @@ let Runner;
  *        "browser": "chrome",
  *        "capabilities": {
  *          "chromeOptions": {
- *            "args": [ "--headless", "--disable-gpu", "--window-size=800,600" ]
+ *            "args": [ "--headless", "--disable-gpu", "--no-sandbox" ]
  *          }
  *        }
  *      }
@@ -436,7 +437,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
-   * {--end--}
    */
   async amOnPage(url) {
     if (!(/^\w+\:\/\//.test(url))) {
@@ -470,9 +470,9 @@ class Protractor 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.
+   * 
    */
   async click(locator, context = null) {
     let matcher = this.browser;
@@ -496,9 +496,9 @@ class Protractor 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.
+   * 
    */
   async doubleClick(locator, context = null) {
     let matcher = this.browser;
@@ -523,9 +523,9 @@ class Protractor 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.
+   * 
    */
   async rightClick(locator, context = null) {
     /**
@@ -555,10 +555,10 @@ class Protractor extends Helper {
    * I.moveCursorTo('#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.
+   * 
    */
   async moveCursorTo(locator, offsetX = null, offsetY = null) {
     let offset = null;
@@ -580,8 +580,7 @@ class Protractor 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.
    */
   async see(text, context = null) {
     return proceedSee.call(this, 'assert', text, context);
@@ -589,10 +588,13 @@ class Protractor extends Helper {
 
   /**
    * Checks that text is equal to provided one.
-   *
+   * 
    * ```js
    * I.seeTextEquals('text', 'h1');
    * ```
+   * 
+   * @param {string} text element value to check.
+   * @param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
    */
   async seeTextEquals(text, context = null) {
     return proceedSee.call(this, 'assert', text, context, true);
@@ -608,9 +610,8 @@ class Protractor 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.
+   * 
    */
   dontSee(text, context = null) {
     return proceedSee.call(this, 'negate', text, context);
@@ -625,8 +626,7 @@ class Protractor extends Helper {
    * console.log(JSON.stringify(logs))
    * ```
    * 
-   * @returns {Promise<Array>} all browser logs
-   * {--end--}
+   * @returns {Promise<Array<*>>} all browser logs
    */
   async grabBrowserLogs() {
     return this.browser.manage().logs().get('browser');
@@ -642,7 +642,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @returns {Promise<string>} current URL
-   * {--end--}
    */
   async grabCurrentUrl() {
     return this.browser.getCurrentUrl();
@@ -667,9 +666,8 @@ class Protractor extends Helper {
    * ```js
    * I.selectOption('Which OS do you use?', ['Android', 'iOS']);
    * ```
-   * @param {string|object} select field located by label|name|CSS|XPath|strict locator.
-   * @param {string|array} option visible text or value of option.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
+   * @param {string|Array<*>} option visible text or value of option.
    */
   async selectOption(select, option) {
     const fields = await findFields(this.browser, select);
@@ -705,9 +703,9 @@ class Protractor 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--}
+   * 
    */
   async fillField(field, value) {
     const els = await findFields(this.browser, field);
@@ -726,8 +724,7 @@ class Protractor extends Helper {
    * I.pressKey(['Control','a']);
    * ```
    * 
-   * @param {string|array} key key or array of keys to press.
-   * {--end--}
+   * @param {string|string[]} key key or array of keys to press.
    * {{ keys }}
    */
   async pressKey(key) {
@@ -759,9 +756,8 @@ class Protractor 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--}
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -787,9 +783,9 @@ class Protractor 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--}
+   * 
    */
   async seeInField(field, value) {
     return proceedSeeInField.call(this, 'assert', field, value);
@@ -804,9 +800,8 @@ class Protractor 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--}
    */
   async dontSeeInField(field, value) {
     return proceedSeeInField.call(this, 'negate', field, value);
@@ -819,9 +814,8 @@ class Protractor 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--}
    */
   async appendField(field, value) {
     const els = await findFields(this.browser, field);
@@ -838,7 +832,6 @@ class Protractor extends Helper {
    * I.clearField('#email');
    * ```
    * @param {string|object} editable field located by label|name|CSS|XPath|strict locator.
-   * {--end--}
    */
   async clearField(field) {
     const els = await findFields(this.browser, field);
@@ -857,9 +850,8 @@ class Protractor 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.
    */
   async checkOption(field, context = null) {
     let matcher = this.browser;
@@ -885,9 +877,8 @@ class Protractor 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.
    */
   async uncheckOption(field, context = null) {
     let matcher = this.browser;
@@ -911,8 +902,8 @@ class Protractor 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.
+   * 
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -927,8 +918,8 @@ class Protractor 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.
+   * 
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -943,9 +934,8 @@ class Protractor 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
    */
   async grabTextFrom(locator) {
     const els = await this._locate(locator);
@@ -967,9 +957,8 @@ class Protractor 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--}
    */
   async grabHTMLFrom(locator) {
     const els = await this._locate(locator);
@@ -992,9 +981,8 @@ class Protractor 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--}
    */
   async grabValueFrom(locator) {
     const els = await findFields(this.browser, locator);
@@ -1010,10 +998,9 @@ class Protractor 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 els = await this._locate(locator, true);
@@ -1034,10 +1021,9 @@ class Protractor 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--}
    */
   async grabAttributeFrom(locator, attr) {
     const els = await this._locate(locator);
@@ -1050,6 +1036,7 @@ class Protractor extends Helper {
     }
     return array.length === 1 ? array[0] : array;
   }
+
   /**
    * Checks that title contains text.
    * 
@@ -1058,7 +1045,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
-   * {--end--}
    */
   async seeInTitle(text) {
     return this.browser.getTitle().then(title => stringIncludes('web page title').assert(text, title));
@@ -1084,7 +1070,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} text value to check.
-   * {--end--}
    */
   async dontSeeInTitle(text) {
     return this.browser.getTitle().then(title => stringIncludes('web page title').negate(text, title));
@@ -1099,7 +1084,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @returns {Promise<string>} title
-   * {--end--}
    */
   async grabTitle() {
     return this.browser.getTitle().then((title) => {
@@ -1115,8 +1099,7 @@ class Protractor 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.
    */
   async seeElement(locator) {
     let els = await this._locate(locator, true);
@@ -1131,8 +1114,7 @@ class Protractor extends Helper {
    * I.dontSeeElement('.modal'); // modal is not shown
    * ```
    * 
-   * @param {string|object} locator located by CSS|XPath|Strict locator.
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
    */
   async dontSeeElement(locator) {
     let els = await this._locate(locator, false);
@@ -1147,8 +1129,8 @@ class Protractor 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.
+   * 
    */
   async seeElementInDOM(locator) {
     return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').negate(els.fill('ELEMENT')));
@@ -1161,8 +1143,7 @@ class Protractor 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.
    */
   async dontSeeElementInDOM(locator) {
     return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').assert(els.fill('ELEMENT')));
@@ -1175,7 +1156,6 @@ class Protractor extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * {--end--}
    */
   async seeInSource(text) {
     return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').assert(text, source));
@@ -1190,7 +1170,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @returns {Promise<string>} source code
-   * {--end--}
    */
   async grabSource() {
     return this.browser.getPageSource();
@@ -1204,7 +1183,7 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * {--end--}
+   * 
    */
   async dontSeeInSource(text) {
     return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').negate(text, source));
@@ -1219,9 +1198,9 @@ class Protractor extends Helper {
    * I.seeNumberOfElements('#submitBtn', 1);
    * ```
    * 
-   * @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 seeNumberOfElements(locator, num) {
     const elements = await this._locate(locator);
@@ -1236,9 +1215,9 @@ class Protractor 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);
@@ -1252,9 +1231,8 @@ class Protractor 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) {
     let els = await this._locate(locator);
@@ -1269,9 +1247,8 @@ class Protractor 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 els = await this._locate(locator);
@@ -1308,9 +1285,8 @@ class Protractor 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 els = await this._locate(locator);
@@ -1361,8 +1337,9 @@ class Protractor 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>}
+   * 
    */
   async executeScript(fn) {
     return this.browser.executeScript.apply(this.browser, arguments);
@@ -1391,8 +1368,9 @@ class Protractor 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>}
+   * 
    */
   async executeAsyncScript(fn) {
     this.browser.manage().timeouts().setScriptTimeout(this.options.scriptTimeout);
@@ -1407,7 +1385,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * {--end--}
    */
   async seeInCurrentUrl(url) {
     return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').assert(url, currentUrl));
@@ -1417,7 +1394,6 @@ class Protractor extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async dontSeeInCurrentUrl(url) {
     return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').negate(url, currentUrl));
@@ -1434,7 +1410,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async seeCurrentUrlEquals(url) {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).assert(url, currentUrl));
@@ -1450,7 +1425,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async dontSeeCurrentUrlEquals(url) {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).negate(url, currentUrl));
@@ -1467,8 +1441,7 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} fileName file name to save.
-   * @param {boolean} fullPage (optional, `false` by default) flag to enable fullscreen screenshot mode.
-   * {--end--}
+   * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
    */
   async saveScreenshot(fileName, fullPage = false) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -1509,8 +1482,7 @@ class Protractor extends Helper {
    * I.clearCookie('test');
    * ```
    * 
-   * @param {string} cookie (optional, `null` by default) cookie name
-   * {--end--}
+   * @param {?string} [cookie=null] (optional, `null` by default) cookie name
    */
   async clearCookie(cookie = null) {
     if (!cookie) {
@@ -1527,7 +1499,7 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
+   * 
    */
   async seeCookie(name) {
     return this.browser.manage().getCookie(name).then(res => truth(`cookie ${name}`, 'to be set').assert(res));
@@ -1541,7 +1513,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
    */
   async dontSeeCookie(name) {
     return this.browser.manage().getCookie(name).then(res => truth(`cookie ${name}`, 'to be set').negate(res));
@@ -1550,16 +1521,15 @@ class Protractor extends Helper {
   /**
    * Gets a cookie object by name.
    * If none provided gets all cookies.
-   * * Resumes test execution, so **should be used inside async with `await`** operator.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
    * 
    * ```js
    * let cookie = await I.grabCookie('auth');
    * assert(cookie.value, '123456');
    * ```
    * 
-   * @param [name=null] cookie name.
+   * @param {?string} [name=null] cookie name.
    * @returns {Promise<string>} attribute value
-   * {--end--}
    *
    * Returns cookie in JSON [format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
    */
@@ -1626,7 +1596,6 @@ class Protractor extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * {--end--}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -1645,7 +1614,6 @@ class Protractor extends Helper {
    * 
    * @param {string|object} srcElement located by CSS|XPath|strict locator.
    * @param {string|object} destElement located by CSS|XPath|strict locator.
-   * {--end--}
    */
   async dragAndDrop(srcElement, destElement) {
     const srcEl = await this._locate(srcElement, true);
@@ -1771,7 +1739,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @returns {Promise<number>} number of open tabs
-   * {--end--}
    */
   async grabNumberOfOpenTabs() {
     const pages = await this.browser.getAllWindowHandles();
@@ -1786,13 +1753,13 @@ class Protractor 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.
    */
   async switchTo(locator) {
     if (Number.isInteger(locator)) {
       return this.browser.switchTo().frame(locator);
-    } else if (!locator) {
+    }
+    if (!locator) {
       return this.browser.switchTo().frame(null);
     }
 
@@ -1809,7 +1776,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * {--end--}
    */
   wait(sec) {
     return this.browser.sleep(sec * 1000);
@@ -1825,9 +1791,8 @@ class Protractor 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
    */
   async waitForElement(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1850,9 +1815,8 @@ class Protractor 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
    */
   async waitForDetached(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1885,9 +1849,8 @@ class Protractor 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
    */
   async waitForVisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1903,9 +1866,8 @@ class Protractor 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
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
@@ -1919,9 +1881,8 @@ class Protractor 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
    */
   async waitForInvisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1943,10 +1904,9 @@ class Protractor 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) {
     function visibilityCountOf(loc, expectedCount) {
@@ -1971,9 +1931,8 @@ class Protractor 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.
    */
   async waitForEnabled(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1994,8 +1953,7 @@ class Protractor 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 aSec = sec || this.options.waitForTimeout;
@@ -2033,9 +1991,9 @@ class Protractor 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
+   * 
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -2060,9 +2018,9 @@ class Protractor 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 {?number} [interval=null]
    */
   async waitUntil(fn, sec = null, timeoutMsg = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -2077,8 +2035,7 @@ class Protractor 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 aSec = sec || this.options.waitForTimeout;
@@ -2104,8 +2061,7 @@ class Protractor 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;
@@ -2137,9 +2093,8 @@ class Protractor 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.
    */
   async waitForText(text, sec = null, context = null) {
     if (!context) {
@@ -2166,7 +2121,7 @@ class Protractor extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * {--end--}
+   * 
    */
   refreshPage() {
     return this.browser.refresh();
@@ -2189,10 +2144,9 @@ class Protractor 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.
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -2224,7 +2178,7 @@ class Protractor extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * {--end--}
+   * 
    */
   async scrollPageToTop() {
     return this.executeScript('window.scrollTo(0, 0);');
@@ -2236,7 +2190,7 @@ class Protractor extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * {--end--}
+   * 
    */
   async scrollPageToBottom() {
     /* eslint-disable prefer-arrow-callback, comma-dangle */
@@ -2259,8 +2213,7 @@ class Protractor extends Helper {
    * let { x, y } = await I.grabPageScrollPosition();
    * ```
    * 
-   * @returns {Promise<object>} scroll position
-   * {--end--}
+   * @returns {Promise<Object<string, *>>} scroll position
    */
   async grabPageScrollPosition() {
     /* eslint-disable comma-dangle */
@@ -2310,7 +2263,6 @@ class Protractor extends Helper {
    * ```
    * 
    * @param {object} cookie a cookie object.
-   * {--end--}
    */
   setCookie(cookie) {
     return this.browser.manage().addCookie(cookie);