codeceptjs 2.3.4 → 2.4.1

package/docs/build/TestCafe.js

@@ -2,11 +2,12 @@
 const fs = require('fs');
 const assert = require('assert');
 const path = require('path');
+const qrcode = require('qrcode-terminal');
 const requireg = require('requireg');
 const createTestCafe = require('testcafe');
 const { Selector, ClientFunction } = require('testcafe');
-const ElementNotFound = require('./errors/ElementNotFound');
 
+const ElementNotFound = require('./errors/ElementNotFound');
 const testControllerHolder = require('./testcafe/testControllerHolder');
 const {
   mapError,
@@ -67,6 +68,21 @@ const getHtmlSource = t => ClientFunction(() => document.getElementsByTagName('h
  * }
  * ```
  *
+ *  To use remote device you can provide 'remote' as browser parameter this will display a link with QR Code
+ *  See https://devexpress.github.io/testcafe/documentation/recipes/test-on-remote-computers-and-mobile-devices.html
+ *  #### Example #2: Remote browser connection
+ *
+ * ```js
+ * {
+ *    helpers: {
+ *      TestCafe : {
+ *        url: "http://localhost",
+ *        waitForTimeout: 15000,
+ *        browser: "remote"
+ *      }
+ *    }
+ * }
+ * ```
  *
  * ## Access From Helpers
  *
@@ -96,7 +112,7 @@ class TestCafe extends Helper {
     this.context = undefined; // TODO Not sure if this applies to testcafe
 
 
-    this.options = Object.assign({
+    this.options = {
       url: 'http://localhost',
       show: false,
       browser: 'chrome',
@@ -108,7 +124,8 @@ class TestCafe extends Helper {
       fullPageScreenshots: false,
       disableScreenshots: false,
       windowSize: undefined,
-    }, config);
+      ...config,
+    };
   }
 
   // TOOD Do a requirements check
@@ -130,12 +147,12 @@ class TestCafe extends Helper {
     ];
   }
 
-  async _startBrowser() {
+  async _configureAndStartBrowser() {
     this.dummyTestcafeFile = createTestFile(global.output_dir); // create a dummy test file to get hold of the test controller
 
     this.iteration += 2; // Use different ports for each test run
     // @ts-ignore
-    this.testcafe = await createTestCafe('localhost', null, null);
+    this.testcafe = await createTestCafe('', null, null);
 
     this.debugSection('_before', 'Starting testcafe browser...');
 
@@ -143,6 +160,19 @@ class TestCafe extends Helper {
 
     // TODO Do we have to cleanup the runner?
     const runner = this.testcafe.createRunner();
+
+    this.options.browser !== 'remote' ? this._startBrowser(runner) : this._startRemoteBrowser(runner);
+
+    this.t = await testControllerHolder.get();
+    assert(this.t, 'Expected to have the testcafe test controller');
+
+    if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
+      const dimensions = this.options.windowSize.split('x');
+      await this.t.resizeWindow(parseInt(dimensions[0], 10), parseInt(dimensions[1], 10));
+    }
+  }
+
+  async _startBrowser(runner) {
     runner
       .src(this.dummyTestcafeFile)
       .screenshots(global.output_dir, !this.options.disableScreenshots)
@@ -166,16 +196,31 @@ class TestCafe extends Helper {
         this.isRunning = false;
         this.testcafe.close();
       });
+  }
 
-    this.t = await testControllerHolder.get();
-    assert(this.t, 'Expected to have the testcafe test controller');
-
-    if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
-      const dimensions = this.options.windowSize.split('x');
-      await this.t.resizeWindow(parseInt(dimensions[0], 10), parseInt(dimensions[1], 10));
-    }
+  async _startRemoteBrowser(runner) {
+    const remoteConnection = await this.testcafe.createBrowserConnection();
+    console.log('Connect your device to the following URL or scan QR Code: ', remoteConnection.url);
+    qrcode.generate(remoteConnection.url);
+    remoteConnection.once('ready', () => {
+      runner
+        .src(this.dummyTestcafeFile)
+        .browsers(remoteConnection)
+        .reporter('minimal')
+        .run({
+          selectorTimeout: this.options.waitForTimeout,
+          skipJsErrors: true,
+          skipUncaughtErrors: true,
+        })
+        .catch((err) => {
+          this.debugSection('_before', `Error ${err.toString()}`);
+          this.isRunning = false;
+          this.testcafe.close();
+        });
+    });
   }
 
+
   async _stopBrowser() {
     this.debugSection('_after', 'Stopping testcafe browser...');
 
@@ -190,19 +235,20 @@ class TestCafe extends Helper {
     this.isRunning = false;
   }
 
-  _init() {}
+  _init() {
+  }
 
   async _beforeSuite() {
     if (!this.options.restart && !this.options.manualStart && !this.isRunning) {
       this.debugSection('Session', 'Starting singleton browser session');
-      return this._startBrowser();
+      return this._configureAndStartBrowser();
     }
   }
 
 
   async _before() {
-    if (this.options.restart && !this.options.manualStart) return this._startBrowser();
-    if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
+    if (this.options.restart && !this.options.manualStart) return this._configureAndStartBrowser();
+    if (!this.isRunning && !this.options.manualStart) return this._configureAndStartBrowser();
     this.context = null;
   }
 
@@ -269,7 +315,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url url path or global url.
-   * {--end--}
    */
   async amOnPage(url) {
     if (!(/^\w+\:\/\//.test(url))) {
@@ -287,7 +332,6 @@ class TestCafe extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * {--end--}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -320,9 +364,9 @@ class TestCafe 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) {
@@ -336,7 +380,7 @@ class TestCafe extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * {--end--}
+   * 
    */
   async refreshPage() {
     // eslint-disable-next-line no-restricted-globals
@@ -351,9 +395,8 @@ class TestCafe 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) {
@@ -378,9 +421,9 @@ class TestCafe 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.call(this, field);
@@ -400,16 +443,16 @@ class TestCafe 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.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
-    return this.t
-      .click(el)
-      .pressKey('ctrl+a delete');
+    const res = await this.t
+      .selectText(el)
+      .pressKey('delete');
+    return res;
   }
 
   /**
@@ -419,9 +462,8 @@ class TestCafe 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) {
@@ -444,9 +486,8 @@ class TestCafe 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(field, pathToFile) {
@@ -471,8 +512,7 @@ class TestCafe 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 }}
    */
@@ -493,10 +533,10 @@ class TestCafe 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) {
@@ -519,9 +559,9 @@ class TestCafe 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) {
@@ -550,9 +590,9 @@ class TestCafe 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) {
@@ -580,9 +620,8 @@ class TestCafe 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 el = await findCheckable.call(this, field, context);
@@ -603,9 +642,8 @@ class TestCafe 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 el = await findCheckable.call(this, field, context);
@@ -626,8 +664,8 @@ class TestCafe 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);
@@ -642,8 +680,8 @@ class TestCafe 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);
@@ -668,9 +706,8 @@ class TestCafe 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 els = await findFields.call(this, select);
@@ -698,8 +735,9 @@ class TestCafe extends Helper {
           await this.t.click(optEl, clickOpts).catch(mapError);
           continue;
         }
-      // eslint-disable-next-line no-empty
-      } catch (err) {}
+        // eslint-disable-next-line no-empty
+      } catch (err) {
+      }
 
       try {
         const sel = `[value="${opt}"]`;
@@ -707,8 +745,9 @@ class TestCafe extends Helper {
         if (await optEl.count) {
           await this.t.click(optEl, clickOpts).catch(mapError);
         }
-      // eslint-disable-next-line no-empty
-      } catch (err) {}
+        // eslint-disable-next-line no-empty
+      } catch (err) {
+      }
     }
   }
 
@@ -720,24 +759,22 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * {--end--}
    */
   async seeInCurrentUrl(url) {
     stringIncludes('url').assert(url, await getPageUrl(this.t)().catch(mapError));
   }
 
   /**
-    * Checks that current url does not contain a provided fragment.
+   * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * {--end--}
-    */
+   */
   async dontSeeInCurrentUrl(url) {
     stringIncludes('url').negate(url, await getPageUrl(this.t)().catch(mapError));
   }
 
   /**
-    * Checks that current url is equal to provided one.
+   * Checks that current url is equal to provided one.
    * If a relative url provided, a configured url will be prepended to it.
    * So both examples will work:
    * 
@@ -747,14 +784,13 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
-    */
+   */
   async seeCurrentUrlEquals(url) {
     urlEquals(this.options.url).assert(url, await getPageUrl(this.t)().catch(mapError));
   }
 
   /**
-    * Checks that current url is not equal to provided one.
+   * Checks that current url is not equal to provided one.
    * If a relative url provided, a configured url will be prepended to it.
    * 
    * ```js
@@ -763,8 +799,7 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * {--end--}
-    */
+   */
   async dontSeeCurrentUrlEquals(url) {
     urlEquals(this.options.url).negate(url, await getPageUrl(this.t)().catch(mapError));
   }
@@ -779,8 +814,7 @@ class TestCafe 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) {
@@ -806,9 +840,8 @@ class TestCafe 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.
+   * 
    *
    */
   async dontSee(text, context = null) {
@@ -831,8 +864,7 @@ class TestCafe 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) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
@@ -848,8 +880,7 @@ class TestCafe 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) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
@@ -865,8 +896,8 @@ class TestCafe 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) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
@@ -882,8 +913,7 @@ class TestCafe 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) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
@@ -900,9 +930,9 @@ class TestCafe 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) {
@@ -919,9 +949,8 @@ class TestCafe 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 count = (await findElements.call(this, this.context, locator)).filterVisible().count;
@@ -938,9 +967,9 @@ class TestCafe 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) {
     // const expectedValue = findElements.call(this, this.context, field).value;
@@ -962,9 +991,8 @@ class TestCafe 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) {
     // const expectedValue = findElements.call(this, this.context, field).value;
@@ -998,7 +1026,6 @@ class TestCafe extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * {--end--}
    */
   async seeInSource(text) {
     const source = await getHtmlSource(this.t)();
@@ -1013,7 +1040,7 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * {--end--}
+   * 
    */
   async dontSeeInSource(text) {
     const source = await getHtmlSource(this.t)();
@@ -1032,8 +1059,7 @@ class TestCafe 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) {
     // TODO Implement full page screenshots
@@ -1054,7 +1080,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * {--end--}
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -1088,8 +1113,9 @@ class TestCafe 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>}
+   * 
    *
    * If a function returns a Promise It will wait for it resolution.
    */
@@ -1107,9 +1133,8 @@ class TestCafe 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 sel = await findElements.call(this, this.context, locator);
@@ -1134,15 +1159,14 @@ class TestCafe 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 sel = await findElements.call(this, this.context, locator);
     assertElementExists(sel);
-    return (await sel.nth(0)).value;
+    return (await sel.nth(0)).getAttribute(attr);
   }
 
   /**
@@ -1152,12 +1176,13 @@ class TestCafe 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) {
-    return this.grabAttributeFrom(locator, 'value');
+    const sel = await findElements.call(this, this.context, locator);
+    assertElementExists(sel);
+    return (await sel.nth(0)).value;
   }
 
   /**
@@ -1169,7 +1194,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @returns {Promise<string>} source code
-   * {--end--}
    */
   async grabSource() {
     return ClientFunction(() => document.documentElement.innerHTML).with({ boundTestRun: this.t })();
@@ -1198,7 +1222,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @returns {Promise<string>} current URL
-   * {--end--}
    */
   async grabCurrentUrl() {
     return ClientFunction(() => document.location.href).with({ boundTestRun: this.t })();
@@ -1212,8 +1235,7 @@ class TestCafe extends Helper {
    * let { x, y } = await I.grabPageScrollPosition();
    * ```
    * 
-   * @returns {Promise<object>} scroll position
-   * {--end--}
+   * @returns {Promise<Object<string, *>>} scroll position
    */
   async grabPageScrollPosition() {
     return ClientFunction(() => ({ x: window.pageXOffset, y: window.pageYOffset })).with({ boundTestRun: this.t })();
@@ -1225,7 +1247,7 @@ class TestCafe extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * {--end--}
+   * 
    */
   scrollPageToTop() {
     return ClientFunction(() => window.scrollTo(0, 0)).with({ boundTestRun: this.t })().catch(mapError);
@@ -1237,7 +1259,7 @@ class TestCafe extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * {--end--}
+   * 
    */
   scrollPageToBottom() {
     return ClientFunction(() => {
@@ -1259,10 +1281,9 @@ class TestCafe 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') {
@@ -1300,8 +1321,7 @@ class TestCafe 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)) {
@@ -1326,7 +1346,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {object} cookie a cookie object.
-   * {--end--}
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -1351,7 +1370,7 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
+   * 
    *
    */
   async seeCookie(name) {
@@ -1367,7 +1386,6 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * {--end--}
    */
   async dontSeeCookie(name) {
     const cookie = await this.grabCookie(name);
@@ -1377,16 +1395,15 @@ class TestCafe 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. If name not passed returns all cookies for this domain.
    */
@@ -1416,8 +1433,7 @@ class TestCafe 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(cookieName) {
     const clearCookies = ClientFunction(() => {
@@ -1444,8 +1460,7 @@ class TestCafe 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 waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1470,8 +1485,7 @@ class TestCafe 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 waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1507,9 +1521,9 @@ class TestCafe 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 = [];
@@ -1522,10 +1536,7 @@ class TestCafe extends Helper {
     }
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
 
-    const clientFn = createClientFunction((urlPart) => {
-      const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href)));
-      return currUrl.indexOf(urlPart) > -1;
-    }, args);
+    const clientFn = createClientFunction(fn, args).with({ boundTestRun: this.t });
 
     return waitForFunction(clientFn, waitTimeout);
   }
@@ -1537,10 +1548,9 @@ class TestCafe 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1560,9 +1570,8 @@ class TestCafe 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1580,9 +1589,8 @@ class TestCafe 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1600,9 +1608,8 @@ class TestCafe 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) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1623,9 +1630,8 @@ class TestCafe 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) {
@@ -1657,7 +1663,7 @@ async function waitForFunction(browserFn, waitTimeout) {
     let result;
     try {
       result = await browserFn();
-    // eslint-disable-next-line no-empty
+      // eslint-disable-next-line no-empty
     } catch (err) {
       throw new Error(`Error running function ${err.toString()}`);
     }