codeceptjs 3.3.0 → 3.3.1

package/docs/build/Nightmare.js

@@ -406,6 +406,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
+   * @return {Promise<any>}
    * @param {?object} headers list of request headers can be passed
    *
    */
@@ -433,6 +434,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} text text value to check.
+   * @return {Promise<any>}
    */
   async seeInTitle(text) {
     const title = await this.browser.title();
@@ -447,6 +449,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} text value to check.
+   * @return {Promise<any>}
    */
   async dontSeeInTitle(text) {
     const title = await this.browser.title();
@@ -490,6 +493,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
+   * @return {Promise<any>}
    */
   async seeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -500,6 +504,7 @@ class Nightmare extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
+   * @return {Promise<any>}
    */
   async dontSeeInCurrentUrl(url) {
     const currentUrl = await this.browser.url();
@@ -517,6 +522,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * @return {Promise<any>}
    */
   async seeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -533,6 +539,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} url value to check.
+   * @return {Promise<any>}
    */
   async dontSeeCurrentUrlEquals(url) {
     const currentUrl = await this.browser.url();
@@ -550,6 +557,7 @@ class Nightmare extends Helper {
    * ```
    * @param {string} text expected on page.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+   * @return {Promise<any>}
    */
   async see(text, context = null) {
     return proceedSee.call(this, 'assert', text, context);
@@ -566,7 +574,7 @@ class Nightmare extends Helper {
    * 
    * @param {string} text which is not present.
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * 
+   * @return {Promise<any>}
    */
   dontSee(text, context = null) {
     return proceedSee.call(this, 'negate', text, context);
@@ -580,6 +588,7 @@ class Nightmare extends Helper {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @return {Promise<any>}
    */
   async seeElement(locator) {
     locator = new Locator(locator, 'css');
@@ -597,6 +606,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * @return {Promise<any>}
    */
   async dontSeeElement(locator) {
     locator = new Locator(locator, 'css');
@@ -615,7 +625,7 @@ class Nightmare extends Helper {
    * I.seeElementInDOM('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-   * 
+   * @return {Promise<any>}
    */
   async seeElementInDOM(locator) {
     locator = new Locator(locator, 'css');
@@ -631,6 +641,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * @return {Promise<any>}
    */
   async dontSeeElementInDOM(locator) {
     locator = new Locator(locator, 'css');
@@ -645,6 +656,7 @@ class Nightmare extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
+   * @return {Promise<any>}
    */
   async seeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -659,7 +671,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * 
+   * @return {Promise<any>}
    */
   async dontSeeInSource(text) {
     const source = await this.browser.evaluate(() => document.documentElement.outerHTML);
@@ -677,7 +689,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * 
+   * @return {Promise<any>}
    */
   async seeNumberOfElements(locator, num) {
     const elements = await this._locate(locator);
@@ -694,7 +706,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * 
+   * @return {Promise<any>}
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
@@ -747,7 +759,8 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-   * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+   * @return {Promise<any>}
    * 
    */
   async click(locator, context = null) {
@@ -770,7 +783,7 @@ class Nightmare extends Helper {
    * 
    * @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.
-   * 
+   * @return {Promise<any>}
    */
   async doubleClick(locator, context = null) {
     const el = await findClickable.call(this, locator, context);
@@ -793,7 +806,7 @@ class Nightmare extends Helper {
    * 
    * @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.
-   * 
+   * @return {Promise<any>}
    */
   async rightClick(locator, context = null) {
     const el = await findClickable.call(this, locator, context);
@@ -814,7 +827,7 @@ class Nightmare extends Helper {
    * @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.
-   * 
+   * @return {Promise<any>}
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
     locator = new Locator(locator, 'css');
@@ -901,6 +914,7 @@ class Nightmare extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
+   * @return {Promise<any>}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -922,6 +936,7 @@ class Nightmare extends Helper {
    * ```
    * @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.
+   * @return {Promise<any>}
    */
   async checkOption(field, context = null) {
     const els = await findCheckable.call(this, field, context);
@@ -943,6 +958,7 @@ class Nightmare extends Helper {
    * ```
    * @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.
+   * @return {Promise<any>}
    */
   async uncheckOption(field, context = null) {
     const els = await findCheckable.call(this, field, context);
@@ -967,7 +983,7 @@ class Nightmare extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * 
+   * @return {Promise<any>}
    */
   async fillField(field, value) {
     const el = await findField.call(this, field);
@@ -985,7 +1001,7 @@ class Nightmare extends Helper {
    * I.clearField('#email');
    * ```
    * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @return {Promise<any>}
    */
   async clearField(field) {
     return this.fillField(field, '');
@@ -1000,6 +1016,7 @@ class Nightmare extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
+   * @return {Promise<any>}
    */
   async appendField(field, value) {
     const el = await findField.call(this, field);
@@ -1020,7 +1037,7 @@ class Nightmare extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * 
+   * @return {Promise<any>}
    */
   async seeInField(field, value) {
     return proceedSeeInField.call(this, 'assert', field, value);
@@ -1037,6 +1054,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
+   * @return {Promise<any>}
    */
   async dontSeeInField(field, value) {
     return proceedSeeInField.call(this, 'negate', field, value);
@@ -1080,7 +1098,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @return {Promise<any>}
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -1096,7 +1114,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * 
+   * @return {Promise<any>}
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -1114,6 +1132,7 @@ class Nightmare extends Helper {
    * 
    * @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.
+   * @return {Promise<any>}
    *
    * 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))
    */
@@ -1387,7 +1406,7 @@ class Nightmare extends Helper {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * 
+   * @return {Promise<any>}
    */
   async selectOption(select, option) {
     const fetchAndCheckOption = function (el, locator) {
@@ -1444,7 +1463,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-   * 
+   * @return {Promise<any>}
    *
    * Wrapper for `.cookies.set(cookie)`.
    * [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie)
@@ -1461,7 +1480,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * 
+   * @return {Promise<any>}
    *
    */
   async seeCookie(name) {
@@ -1477,6 +1496,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
+   * @return {Promise<any>}
    */
   async dontSeeCookie(name) {
     const res = await this.browser.cookies.get(name);
@@ -1515,6 +1535,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {?string} [cookie=null] (optional, `null` by default) cookie name
+   * @return {Promise<any>}
    */
   async clearCookie(cookie) {
     if (!cookie) {
@@ -1540,7 +1561,7 @@ class Nightmare extends Helper {
    * @param {string|function} fn to be executed in browser context.
    * @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
-   * 
+   * @return {Promise<any>}
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -1563,6 +1584,7 @@ class Nightmare extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
+   * @return {Promise<any>}
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -1583,6 +1605,7 @@ class Nightmare extends Helper {
    * @param {string }text to wait for.
    * @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.
+   * @return {Promise<any>}
    */
   async waitForText(text, sec, context = null) {
     if (!context) {
@@ -1611,7 +1634,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * 
+   * @return {Promise<any>}
    */
   waitForVisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1638,6 +1661,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * @return {Promise<any>}
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
@@ -1653,6 +1677,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * @return {Promise<any>}
    */
   waitForInvisible(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1680,6 +1705,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
+   * @return {Promise<any>}
    */
   async waitForElement(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1709,6 +1735,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+   * @return {Promise<any>}
    */
   async waitForDetached(locator, sec) {
     this.browser.options.waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1728,7 +1755,7 @@ class Nightmare extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * 
+   * @return {Promise<any>}
    */
   async refreshPage() {
     return this.browser.refresh();
@@ -1752,7 +1779,7 @@ class Nightmare extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} fileName file name to save.
-   * 
+   * @return {Promise<any>}
    *
    */
   async saveElementScreenshot(locator, fileName) {
@@ -1832,6 +1859,7 @@ class Nightmare extends Helper {
    * 
    * @param {string} fileName file name to save.
    * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+   * @return {Promise<any>}
    */
   async saveScreenshot(fileName, fullPage = this.options.fullPageScreenshots) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -1864,6 +1892,7 @@ class Nightmare extends Helper {
    * @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.
+   * @return {Promise<any>}
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1890,7 +1919,7 @@ class Nightmare extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * 
+   * @return {Promise<any>}
    */
   async scrollPageToTop() {
     return this.executeScript(() => window.scrollTo(0, 0));
@@ -1902,7 +1931,7 @@ class Nightmare extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * 
+   * @return {Promise<any>}
    */
   async scrollPageToBottom() {
     /* eslint-disable prefer-arrow-callback, comma-dangle */