codeceptjs 2.3.4 → 2.4.1

package/docs/build/Nightmare.js

@@ -1,4 +1,7 @@
+const path = require('path');
 const requireg = require('requireg');
+const urlResolve = require('url').resolve;
+
 const Helper = require('../helper');
 const stringIncludes = require('../assert/include').includes;
 const urlEquals = require('../assert/equal').urlEquals;
@@ -6,9 +9,7 @@ const equals = require('../assert/equal').equals;
 const empty = require('../assert/empty').empty;
 const truth = require('../assert/truth').truth;
 const Locator = require('../locator');
-const path = require('path');
 const ElementNotFound = require('./errors/ElementNotFound');
-const urlResolve = require('url').resolve;
 const {
   xpathLocator,
   fileExists,
@@ -405,8 +406,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
-   * {--end--}
-   * @param headers {object} list of request headers can be passed
+   * @param {?object} headers list of request headers can be passed
    *
    */
   async amOnPage(url, headers = null) {
@@ -433,7 +433,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
-   * {--end--}
    */
   async seeInTitle(text) {
     const title = await this.browser.title();
@@ -448,7 +447,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} text value to check.
-   * {--end--}
    */
   async dontSeeInTitle(text) {
     const title = await this.browser.title();
@@ -464,7 +462,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @returns {Promise<string>} title
-   * {--end--}
    */
   async grabTitle() {
     return this.browser.title();
@@ -480,7 +477,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @returns {Promise<string>} current URL
-   * {--end--}
    */
   async grabCurrentUrl() {
     return this.browser.url();
@@ -494,7 +490,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * {--end--}
    */
   async seeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -505,7 +500,6 @@ class Nightmare extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async dontSeeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -523,7 +517,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async seeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -540,7 +533,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
    */
   async dontSeeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -557,8 +549,7 @@ class Nightmare 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);
@@ -574,9 +565,8 @@ class Nightmare 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);
@@ -589,8 +579,7 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -607,8 +596,7 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -626,8 +614,8 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -642,8 +630,7 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -658,7 +645,6 @@ class Nightmare extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * {--end--}
    */
   async seeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -673,7 +659,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * {--end--}
+   * 
    */
   async dontSeeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -689,9 +675,9 @@ class Nightmare 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);
@@ -706,9 +692,9 @@ class Nightmare 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);
@@ -722,9 +708,8 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -760,9 +745,9 @@ class Nightmare 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) {
     const el = await findClickable.call(this, locator, context);
@@ -782,9 +767,9 @@ class Nightmare 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) {
     const el = await findClickable.call(this, locator, context);
@@ -806,9 +791,9 @@ class Nightmare 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) {
     const el = await findClickable.call(this, locator, context);
@@ -827,10 +812,10 @@ class Nightmare 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 = 0, offsetY = 0) {
     locator = new Locator(locator, 'css');
@@ -866,8 +851,9 @@ class Nightmare 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>}
+   * 
    *
    * Wrapper for synchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2)
    */
@@ -899,8 +885,9 @@ class Nightmare 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>}
+   * 
    *
    * Wrapper for asynchronous [evaluate](https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2).
    * Unlike NightmareJS implementation calling `done` will return its first argument.
@@ -916,7 +903,6 @@ class Nightmare extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * {--end--}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -936,9 +922,8 @@ class Nightmare 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) {
     const els = await findCheckable.call(this, field, context);
@@ -958,9 +943,8 @@ class Nightmare 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) {
     const els = await findCheckable.call(this, field, context);
@@ -983,9 +967,9 @@ class Nightmare 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 el = await findField.call(this, field);
@@ -1003,7 +987,6 @@ class Nightmare extends Helper {
    * I.clearField('#email');
    * ```
    * @param {string|object} editable field located by label|name|CSS|XPath|strict locator.
-   * {--end--}
    */
   async clearField(field) {
     return this.fillField(field, '');
@@ -1016,9 +999,8 @@ class Nightmare 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 el = await findField.call(this, field);
@@ -1037,9 +1019,9 @@ class Nightmare 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);
@@ -1054,9 +1036,8 @@ class Nightmare 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);
@@ -1099,8 +1080,8 @@ class Nightmare 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);
@@ -1115,8 +1096,8 @@ class Nightmare 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);
@@ -1132,13 +1113,10 @@ class Nightmare 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--}
    *
    * Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more](https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs))
-   *
-   * @param locator CSS locator (XPath not allowed)
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -1163,9 +1141,8 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -1187,9 +1164,8 @@ class Nightmare 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 el = await findField.call(this, locator);
@@ -1205,10 +1181,9 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -1233,9 +1208,8 @@ class Nightmare 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) {
     locator = new Locator(locator, 'css');
@@ -1276,9 +1250,8 @@ class Nightmare 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 fetchAndCheckOption = function (el, locator) {
@@ -1328,7 +1301,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {object} cookie a cookie object.
-   * {--end--}
    *
    * Wrapper for `.cookies.set(cookie)`.
    * [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie)
@@ -1345,7 +1317,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
+   * 
    *
    */
   async seeCookie(name) {
@@ -1361,7 +1333,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
    */
   async dontSeeCookie(name) {
     const res = await this.browser.cookies.get(name);
@@ -1371,18 +1342,17 @@ class Nightmare 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 Promise<object> Cookie in JSON format. If name not passed returns all cookies for this domain.
+   * Cookie in JSON format. If name not passed returns all cookies for this domain.
    *
    * Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
    */
@@ -1399,8 +1369,7 @@ class Nightmare 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) {
     if (!cookie) {
@@ -1424,9 +1393,9 @@ class Nightmare 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 = [];
@@ -1449,7 +1418,6 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * {--end--}
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -1468,9 +1436,8 @@ class Nightmare 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, context = null) {
     if (!context) {
@@ -1497,9 +1464,8 @@ class Nightmare 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
    */
   waitForVisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1524,9 +1490,8 @@ class Nightmare 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);
@@ -1540,9 +1505,8 @@ class Nightmare 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
    */
   waitForInvisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1568,9 +1532,8 @@ class Nightmare 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) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1598,9 +1561,8 @@ class Nightmare 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) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1620,7 +1582,7 @@ class Nightmare extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * {--end--}
+   * 
    */
   async refreshPage() {
     return this.browser.refresh();
@@ -1645,8 +1607,7 @@ class Nightmare 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 = this.options.fullPageScreenshots) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -1677,10 +1638,9 @@ class Nightmare 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') {
@@ -1707,7 +1667,7 @@ class Nightmare extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * {--end--}
+   * 
    */
   async scrollPageToTop() {
     return this.executeScript(() => window.scrollTo(0, 0));
@@ -1719,7 +1679,7 @@ class Nightmare extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * {--end--}
+   * 
    */
   async scrollPageToBottom() {
     /* eslint-disable prefer-arrow-callback, comma-dangle */
@@ -1742,8 +1702,7 @@ class Nightmare 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 */