codeceptjs 3.2.0 → 3.3.0-beta.1

package/docs/bdd.md

@@ -5,7 +5,7 @@ title: Behavior Driven Development
 
 # Behavior Driven Development
 
-Behavior Driven Development (BDD) is a popular software development methodology. BDD is considered an extension of TDD, and is greatly inspired by [Agile](http://agilemanifesto.org/) practices. The primary reason to choose BDD as your development process is to break down communication barriers between business and technical teams. BDD encourages the use of automated testing to verify all documented features of a project from the very beginning. This is why it is common to talk about BDD in the context of test frameworks (like CodeceptJS). The BDD approach, however, is about much more than testing - it is a common language for all team members to use during the development process.
+Behavior Driven Development (BDD) is a popular software development methodology. BDD is considered an extension of TDD, and is greatly inspired by [Agile](https://agilemanifesto.org/) practices. The primary reason to choose BDD as your development process is to break down communication barriers between business and technical teams. BDD encourages the use of automated testing to verify all documented features of a project from the very beginning. This is why it is common to talk about BDD in the context of test frameworks (like CodeceptJS). The BDD approach, however, is about much more than testing - it is a common language for all team members to use during the development process.
 
 ## What is Behavior Driven Development
 
@@ -55,7 +55,7 @@ I should see that total number of products I want to buy is 2
 And my order amount is $1600
 ```
 
-As we can see this simple story highlights core concepts that are called *contracts*. We should fulfill those contracts to model software correctly. But how we can verify that those contracts are being satisfied? [Cucumber](http://cucumber.io) introduced a special language for such stories called **Gherkin**. Same story transformed to Gherkin will look like this:
+As we can see this simple story highlights core concepts that are called *contracts*. We should fulfill those contracts to model software correctly. But how we can verify that those contracts are being satisfied? [Cucumber](https://cucumber.io) introduced a special language for such stories called **Gherkin**. Same story transformed to Gherkin will look like this:
 
 ```gherkin
 Feature: checkout process

package/docs/build/ApiDataFactory.js

@@ -257,13 +257,16 @@ class ApiDataFactory extends Helper {
    * // create user with defined email
    * // and receive it when inside async function
    * const user = await I.have('user', { email: 'user@user.com'});
+   * // create a user with options that will not be included in the final request
+   * I.have('user', { }, { age: 33, height: 55 })
    * ```
    *
    * @param {*} factory factory to use
    * @param {*} params predefined parameters
+   * @param {*} options options for programmatically generate the attributes
    */
-  have(factory, params) {
-    const item = this._createItem(factory, params);
+  have(factory, params, options) {
+    const item = this._createItem(factory, params, options);
     this.debug(`Creating ${factory} ${JSON.stringify(item)}`);
     return this._requestCreate(factory, item);
   }
@@ -277,21 +280,25 @@ class ApiDataFactory extends Helper {
    *
    * // create 3 posts by one author
    * I.haveMultiple('post', 3, { author: 'davert' });
+   *
+   * // create 3 posts by one author with options
+   * I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
    * ```
    *
    * @param {*} factory
    * @param {*} times
    * @param {*} params
+   * @param {*} options
    */
-  haveMultiple(factory, times, params) {
+  haveMultiple(factory, times, params, options) {
     const promises = [];
     for (let i = 0; i < times; i++) {
-      promises.push(this.have(factory, params));
+      promises.push(this.have(factory, params, options));
     }
     return Promise.all(promises);
   }
 
-  _createItem(model, data) {
+  _createItem(model, data, options) {
     if (!this.factories[model]) {
       throw new Error(`Factory ${model} is not defined in config`);
     }
@@ -303,7 +310,7 @@ class ApiDataFactory extends Helper {
         modulePath = path.join(global.codecept_dir, modulePath);
       }
       const builder = require(modulePath);
-      return builder.build(data);
+      return builder.build(data, options);
     } catch (err) {
       throw new Error(`Couldn't load factory file from ${modulePath}, check that
 

package/docs/build/Appium.js

@@ -331,6 +331,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
@@ -373,6 +374,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
@@ -393,6 +395,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {*} fn
+   * @return {Promise<any>}
    */
   /* eslint-disable */
   async runInWeb(fn) {
@@ -434,6 +437,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -451,6 +455,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -467,6 +472,7 @@ class Appium extends Webdriver {
    * I.installApp('/path/to/file.apk');
    * ```
    * @param {string} path path to apk file
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -508,6 +514,7 @@ class Appium extends Webdriver {
    * I.seeCurrentActivityIs(".HomeScreenActivity")
    * ```
    * @param {string} currentActivity
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -524,6 +531,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsLocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsLocked() {
@@ -539,6 +548,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsUnlocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsUnlocked() {
@@ -555,6 +566,8 @@ class Appium extends Webdriver {
    * I.seeOrientationIs('LANDSCAPE')
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
    *
    * Appium: support Android and iOS
@@ -586,6 +599,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -609,6 +623,8 @@ class Appium extends Webdriver {
    * let contexts = await I.grabAllContexts();
    * ```
    *
+   * @return {Promise<string[]>}
+   *
    * Appium: support Android and iOS
    */
   async grabAllContexts() {
@@ -623,6 +639,8 @@ class Appium extends Webdriver {
    * let context = await I.grabContext();
    * ```
    *
+   * @return {Promise<string|null>}
+   *
    * Appium: support Android and iOS
    */
   async grabContext() {
@@ -637,6 +655,8 @@ class Appium extends Webdriver {
    * let activity = await I.grabCurrentActivity();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support only Android
    */
   async grabCurrentActivity() {
@@ -653,6 +673,8 @@ class Appium extends Webdriver {
    * let con = await I.grabNetworkConnection();
    * ```
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async grabNetworkConnection() {
@@ -673,6 +695,8 @@ class Appium extends Webdriver {
    * let orientation = await I.grabOrientation();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabOrientation() {
@@ -689,6 +713,8 @@ class Appium extends Webdriver {
    * let settings = await I.grabSettings();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabSettings() {
@@ -720,6 +746,8 @@ class Appium extends Webdriver {
    * I.switchToWeb('WEBVIEW_io.selendroid.testapp');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {string} [context]
    */
   async switchToWeb(context) {
@@ -747,6 +775,7 @@ class Appium extends Webdriver {
    * I.switchToNative('SOME_OTHER_CONTEXT');
    * ```
    * @param {*} context
+   * @return {Promise<void>}
    */
   async switchToNative(context = null) {
     this.isWeb = false;
@@ -763,6 +792,8 @@ class Appium extends Webdriver {
    * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async startActivity(appPackage, appActivity) {
@@ -786,6 +817,8 @@ class Appium extends Webdriver {
    * ```
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async setNetworkConnection(value) {
@@ -801,6 +834,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {object} settings object
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -841,6 +875,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {number} keyValue  Device specific key value
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -859,6 +894,8 @@ class Appium extends Webdriver {
    * I.openNotifications();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async openNotifications() {
@@ -877,6 +914,8 @@ class Appium extends Webdriver {
    * I.makeTouchAction("~buttonStartWebviewCD", 'tap');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support Android and iOS
    */
   async makeTouchAction(locator, action) {
@@ -898,6 +937,8 @@ class Appium extends Webdriver {
    *
    * Shortcut for `makeTouchAction`
    *
+   * @return {Promise<void>}
+   *
    * @param {*} locator
    */
   async tap(locator) {
@@ -914,10 +955,11 @@ class Appium extends Webdriver {
    *
    * [See complete reference](http://webdriver.io/api/mobile/swipe.html)
    *
-   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {string | object} locator
    * @param {number} xoffset
    * @param {number} yoffset
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -934,11 +976,11 @@ class Appium extends Webdriver {
    * Perform a swipe on the screen.
    *
    * ```js
-   * I.performswipe(100,200);
+   * I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
    * ```
    *
-   * @param {number} from
-   * @param {number} to
+   * @param {object} from
+   * @param {object} to
    *
    * Appium: support Android and iOS
    */
@@ -968,9 +1010,10 @@ class Appium extends Webdriver {
    * I.swipeDown(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {string | object} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -996,9 +1039,10 @@ class Appium extends Webdriver {
    * I.swipeLeft(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {string | object} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1022,9 +1066,10 @@ class Appium extends Webdriver {
    * I.swipeRight(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {string | object} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1048,9 +1093,10 @@ class Appium extends Webdriver {
    * I.swipeUp(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {string | object} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1084,6 +1130,7 @@ class Appium extends Webdriver {
    * @param {number} timeout
    * @param {number} offset
    * @param {number} speed
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1181,6 +1228,10 @@ class Appium extends Webdriver {
    * I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
    * ```
    *
+   * @param {string} path
+   * @param {string} dest
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async pullFile(path, dest) {
@@ -1200,6 +1251,8 @@ class Appium extends Webdriver {
    * I.shakeDevice();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async shakeDevice() {
@@ -1216,6 +1269,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/rotate.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async rotate(x, y, duration, radius, rotation, touchCount) {
@@ -1228,6 +1283,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setImmediateValue.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async setImmediateValue(id, value) {
@@ -1244,6 +1301,8 @@ class Appium extends Webdriver {
    * I.touchId(false); // simulates invalid fingerprint
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    * TODO: not tested
    */
@@ -1260,6 +1319,8 @@ class Appium extends Webdriver {
    * I.closeApp();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async closeApp() {
@@ -1274,7 +1335,7 @@ class Appium extends Webdriver {
    * ```js
    * I.appendField('#myTextField', 'appended');
    * ```
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
    *
    */
@@ -1294,8 +1355,8 @@ class Appium extends Webdriver {
    * I.checkOption('I Agree to Terms and Conditions');
    * I.checkOption('agree', '//form');
    * ```
-   * @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.
+   * @param {string | object} field checkbox located by label | name | CSS | XPath | strict locator.
+   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
    *
    */
   async checkOption(field) {
@@ -1326,8 +1387,8 @@ class Appium extends Webdriver {
    * I.click({css: 'nav a.login'});
    * ```
    * 
-   * @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 {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+   * @param {?string | object} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
    * 
    *
    */
@@ -1345,7 +1406,7 @@ class Appium extends Webdriver {
    * I.dontSeeCheckboxIsChecked('agree'); // located by name
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
    * 
    *
    */
@@ -1361,7 +1422,7 @@ class Appium extends Webdriver {
    * I.dontSeeElement('.modal'); // modal is not shown
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
+   * @param {string | object} locator located by CSS|XPath|Strict locator.
    */
   async dontSeeElement(locator) {
     if (this.isWeb) return super.dontSeeElement(locator);
@@ -1377,7 +1438,7 @@ class Appium extends Webdriver {
    * I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
    *
    */
@@ -1396,7 +1457,7 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {string} text which is not present.
-   * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+   * @param {string | object} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
    * 
    */
   async dontSee(text, context = null) {
@@ -1418,8 +1479,8 @@ class Appium extends Webdriver {
    * // or by strict locator
    * I.fillField({css: 'form#login input[name=username]'}, 'John');
    * ```
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {CodeceptJS.StringOrSecret} value text value to fill.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} value text value to fill.
    * 
    *
    */
@@ -1437,7 +1498,7 @@ class Appium extends Webdriver {
    * let pins = await I.grabTextFromAll('#pin li');
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @returns {Promise<string[]>} attribute value
    * 
    *
@@ -1456,7 +1517,7 @@ class Appium extends Webdriver {
    * ```
    * If multiple elements found returns first element.
    * 
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @returns {Promise<string>} attribute value
    * 
    *
@@ -1474,7 +1535,7 @@ class Appium extends Webdriver {
    * let numOfElements = await I.grabNumberOfVisibleElements('p');
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @param {string | object} locator located by CSS|XPath|strict locator.
    * @returns {Promise<number>} number of visible elements
    */
   async grabNumberOfVisibleElements(locator) {
@@ -1492,7 +1553,7 @@ class Appium extends Webdriver {
    * ```js
    * let hint = await I.grabAttributeFrom('#tooltip', 'title');
    * ```
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @param {string} attr attribute name.
    * @returns {Promise<string>} attribute value
    * 
@@ -1510,7 +1571,7 @@ class Appium extends Webdriver {
    * ```js
    * let hints = await I.grabAttributeFromAll('.tooltip', 'title');
    * ```
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @param {string} attr attribute name.
    * @returns {Promise<string[]>} attribute value
    * 
@@ -1527,7 +1588,7 @@ class Appium extends Webdriver {
    * ```js
    * let inputs = await I.grabValueFromAll('//form/input');
    * ```
-   * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
    * @returns {Promise<string[]>} attribute value
    * 
    *
@@ -1545,7 +1606,7 @@ class Appium extends Webdriver {
    * ```js
    * let email = await I.grabValueFrom('input[name=email]');
    * ```
-   * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
    * @returns {Promise<string>} attribute value
    * 
    *
@@ -1564,6 +1625,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} fileName file name to save.
+   * @return {Promise<void>}
    */
   async saveScreenshot(fileName) {
     return super.saveScreenshot(fileName, false);
@@ -1578,7 +1640,7 @@ class Appium extends Webdriver {
    * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
    * ```
    * 
-   * @param {LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @param {string | object} locator located by CSS|XPath|strict locator.
    * @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
    * 
    *
@@ -1597,7 +1659,7 @@ class Appium extends Webdriver {
    * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
    * 
    *
    */
@@ -1613,7 +1675,7 @@ class Appium extends Webdriver {
    * ```js
    * I.seeElement('#modal');
    * ```
-   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @param {string | object} locator located by CSS|XPath|strict locator.
    *
    */
   async seeElement(locator) {
@@ -1631,7 +1693,7 @@ class Appium extends Webdriver {
    * I.seeInField('form input[type=hidden]','hidden_value');
    * I.seeInField('#searchform input','Search');
    * ```
-   * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
    * 
    *
@@ -1651,7 +1713,7 @@ class Appium extends Webdriver {
    * I.see('Register', {css: 'form.register'}); // use strict locator
    * ```
    * @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.
+   * @param {?string | object} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
    *
    */
   async see(text, context) {
@@ -1678,7 +1740,7 @@ class Appium extends Webdriver {
    * ```js
    * I.selectOption('Which OS do you use?', ['Android', 'iOS']);
    * ```
-   * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
    * 
    *
@@ -1698,7 +1760,7 @@ class Appium extends Webdriver {
    * I.waitForElement('.btn.continue', 5); // wait for 5 secs
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
    *
    */
@@ -1715,7 +1777,7 @@ class Appium extends Webdriver {
    * I.waitForVisible('#popup');
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * 
    *
@@ -1733,7 +1795,7 @@ class Appium extends Webdriver {
    * I.waitForInvisible('#popup');
    * ```
    * 
-   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string | object} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    *
    */
@@ -1754,7 +1816,7 @@ class Appium extends Webdriver {
    * 
    * @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.
+   * @param {string | object} [context] (optional) element located by CSS|XPath|strict locator.
    *
    */
   async waitForText(text, sec = null, context = null) {

package/docs/build/FileSystem.js

@@ -15,7 +15,17 @@ const { fileEquals } = require('../assert/equal');
  * I.amInPath('test');
  * I.seeFile('codecept.json');
  * I.seeInThisFile('FileSystem');
- * I.dontSeeInThisFile("WebDriverIO");
+ * I.dontSeeInThisFile("WebDriver");
+ * ```
+ *
+ * ## Configuration
+ *
+ * Enable helper in config file:
+ *
+ * ```js
+ * helpers: {
+ *     FileSystem: {},
+ * }
  * ```
  *
  * ## Methods