codeceptjs 2.3.4 → 2.4.1

package/docs/bdd.md

@@ -1,15 +1,17 @@
 ---
-id: bdd
+permalink: /bdd
 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.
 
 ## What is Behavior Driven Development
 
 BDD was introduced by [Dan North](https://dannorth.net/introducing-bdd/). He described it as:
 
->  outside-in, pull-based, multiple-stakeholder, multiple-scale, high-automation, agile methodology. It describes a cycle of interactions with well-defined outputs, resulting in the delivery of working, tested software that matters.
+> outside-in, pull-based, multiple-stakeholder, multiple-scale, high-automation, agile methodology. It describes a cycle of interactions with well-defined outputs, resulting in the delivery of working, tested software that matters.
 
 BDD has its own evolution from the days it was born, started by replacing "test" to "should" in unit tests, and moving towards powerful tools like Cucumber and Behat, which made user stories (human readable text) to be executed as an acceptance test.
 
@@ -221,14 +223,14 @@ Steps in background are defined the same way as in scenarios.
 Scenarios can become more descriptive when you represent repeating data as tables. Instead of writing several steps "I have product with :num1 $ price in my cart" we can have one step with multiple values in it.
 
 ```gherkin
-  Given i have products in my cart
+  Given I have products in my cart
     | name         | category    | price  |
     | Harry Potter | Books       | 5      |
     | iPhone 5     | Smartphones | 1200   |
     | Nuclear Bomb | Weapons     | 100000 |
 ```
 
-Tables is a recommended ways to pass arrays into test scenarios.
+Tables are the recommended way to pass arrays into test scenarios.
 Inside a step definition data is stored in argument passed as `DataTable` JavaScript object.
 You can iterate on it like this:
 
@@ -245,7 +247,30 @@ Given('I have products in my cart', (table) => { // eslint-disable-line
     // take values
     const name = cells[0].value;
     const category = cells[1].value;
-    const price = cells[1].value;
+    const price = cells[2].value;
+    // ...
+  }
+});
+```
+
+You can also use the `parse()` method to obtain an object that allow you to get a simple version of the table parsed by column or row, with header (or not):
+
+- `raw()` - returns the table as a 2-D array
+- `rows()` - returns the table as a 2-D array, without the first row
+- `hashes()` - returns an array of objects where each row is converted to an object (column header is the key)
+
+If we use hashes() with the previous exemple :
+
+```js
+Given('I have products in my cart', (table) => { // eslint-disable-line
+  //parse the table by header
+  const tableByHeader = table.parse().hashes();
+  for (const row in tableByHeader) {
+
+    // take values
+    const name = row.name;
+    const category = row.category;
+    const price = row.price;
     // ...
   }
 });

package/docs/best.md

@@ -1,8 +1,10 @@
 ---
-id: best
+permalink: /best
 title: Best Practices
 ---
 
+# Best Practices
+
 ## Focus on Readability
 
 In CodeceptJS we encourage users to follow semantic elements on page while writing tests.
@@ -22,7 +24,7 @@ Even a text on the button changes its much easier to update it.
 
 > If your code goes beyond using `I` object or page objects, you are probably doing something wrong.
 
-When it's hard to match text to element we recommend using [locator builder](https://codecept.io/locators#locator-builder). It allows to build complex locators via fluent API.
+When it's hard to match text to element we recommend using [locator builder](/locators#locator-builder). It allows to build complex locators via fluent API.
 So if you want to click an element which is not a button or a link and use its text you can use `locate()` to build a readable locator:
 
 ```js
@@ -35,10 +37,10 @@ I.click(locate('.button').withText('Click me'));
 To write simpler and effective tests we encourage to use short cuts.
 Make test be focused on one feature and try to simplify everything that is not related directly to test.
 
-* If data is required for a test, try to create that data via API. See how to do it in [Data Management](https://codecept.io/data) chapter.
-* If user login is required, use [autoLogin plugin](https://codecept.io/plugins#autoLogin) instead of putting login steps inside a test.
+* If data is required for a test, try to create that data via API. See how to do it in [Data Management](/data) chapter.
+* If user login is required, use [autoLogin plugin](/plugins#autoLogin) instead of putting login steps inside a test.
 * Break a long test into few. Long test can be fragile and complicated to follow and update.
-* Use [custom steps and page objects](https://codecept.io/pageobjects) to hide steps which are not relevant to current test.
+* Use [custom steps and page objects](/pageobjects) to hide steps which are not relevant to current test.
 
 Make test as simple as:
 
@@ -70,7 +72,7 @@ Here is a recommended strategy what to store where:
 * When site-wide widgets are used, interactions with them should be placed in **Page Fragments**. This should be applied to global navigation, modals, widgets.
 * A custom action that require some low-level driver access, should be placed into a **Helper**. For instance, database connections, complex mouse actions, email testing, filesystem, services access.
 
-> [Learn more](https://codecept.io/pageobjects) about different refactoring options
+> [Learn more](/pageobjects) about different refactoring options
 
 However, it's recommended to not overengineer and keep tests simple. If a test code doesn't require reusage at this point it should not be transformed to use page objects.
 

package/docs/books.md

@@ -1,8 +1,12 @@
 ---
-id: books
+permalink: /books
+layout: Section
+sidebar: false
 title: Books & Posts
+editLink: false
 ---
 
+# Books & Posts
 > Add your own books or posts to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
 ### [Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)
 
@@ -27,6 +31,7 @@ A list of good educational posts about CodeceptJS
 
 * [QA Automation From Zero-to-Hero with CodeceptJS End-to-End Testing](https://medium.com/@dan.ryan.emmons/qa-automation-from-zero-to-hero-with-codeceptjs-end-to-end-testing-719db9d6ff5c) by Dan Emmons
 * [Effective End2End Tests with CodeceptJS](https://hackernoon.com/effective-end-2-end-testing-in-javascript-with-codeceptjs-37c8d7d6a928) by @davertmik
+* [Customizing CodeceptJS Skeleton](https://medium.com/@successivetech/codeceptjs-skeleton-9ba86d3b45ec)
 * [Running End to End tests as Google Cloud Functions](https://hackernoon.com/running-end-to-end-tests-as-google-cloud-functions-f5e34ffc3984)
 * [End-To-End Testing With CodeceptJS](https://www.monterail.com/blog/end-to-end-testing-with-codeceptjs) by Piotr Michalski
 * [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)

package/docs/build/Appium.js

@@ -1,11 +1,13 @@
 let webdriverio;
 let wdioV4;
 let SCREEN_SIZE;
+
+const fs = require('fs');
+const requireg = require('requireg');
+
 const Webdriver = require('./WebDriver');
 const AssertionFailedError = require('../assert/error');
 const truth = require('../assert/truth').truth;
-const requireg = require('requireg');
-const fs = require('fs');
 const recorder = require('../recorder');
 const Locator = require('../locator');
 const ConnectionRefused = require('./errors/ConnectionRefused');
@@ -249,7 +251,8 @@ class Appium extends Webdriver {
         width: res.value[0],
         height: res.value[1],
       });
-    } else if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0 && !this.platform) {
+    }
+    if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0 && !this.platform) {
       const dimensions = this.options.windowSize.split('x');
       await this.browser.windowHandleSize({
         width: dimensions[0],
@@ -435,7 +438,7 @@ class Appium extends Webdriver {
    * I.seeAppIsInstalled("com.example.android.apis");
    * ```
    *
-   * @param bundleId String  ID of bundled app
+   * @param {string} bundleId String  ID of bundled app
    *
    * Appium: support only Android
    */
@@ -452,7 +455,7 @@ class Appium extends Webdriver {
    * I.seeAppIsNotInstalled("com.example.android.apis");
    * ```
    *
-   * @param bundleId String  ID of bundled app
+   * @param {string} bundleId String  ID of bundled app
    *
    * Appium: support only Android
    */
@@ -468,7 +471,7 @@ class Appium extends Webdriver {
    * ```js
    * I.installApp('/path/to/file.apk');
    * ```
-   * @param path path to apk file
+   * @param {string} path path to apk file
    *
    * Appium: support only Android
    */
@@ -483,7 +486,8 @@ class Appium extends Webdriver {
    * ```js
    * I.removeApp('appName', 'com.example.android.apis');
    * ```
-   * @param bundleId String  ID of bundle
+   * @param {string} appId
+   * @param {string}  bundleId String  ID of bundle
    *
    * Appium: support only Android
    */
@@ -507,6 +511,7 @@ class Appium extends Webdriver {
    * ```js
    * I.seeCurrentActivityIs(".HomeScreenActivity")
    * ```
+   * @param {string} currentActivity
    *
    * Appium: support only Android
    */
@@ -554,7 +559,7 @@ class Appium extends Webdriver {
    * I.seeOrientationIs('LANDSCAPE')
    * ```
    *
-   * @param orientation LANDSCAPE or PORTRAIT
+   * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
    *
    * Appium: support Android and iOS
    */
@@ -584,7 +589,7 @@ class Appium extends Webdriver {
    * I.setOrientation('LANDSCAPE')
    * ```
    *
-   * @param orientation LANDSCAPE or PORTRAIT
+   * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
    *
    * Appium: support Android and iOS
    */
@@ -700,7 +705,7 @@ class Appium extends Webdriver {
   /**
    * Switch to the specified context.
    *
-   * @param context the context to switch to
+   * @param {*} context the context to switch to
 
    */
   async _switchToContext(context) {
@@ -799,7 +804,7 @@ class Appium extends Webdriver {
    * I.setSettings({cyberdelia: 'open'});
    * ```
    *
-   * @param settings object
+   * @param {object} settings object
    *
    * Appium: support Android and iOS
    */
@@ -820,7 +825,7 @@ class Appium extends Webdriver {
    * I.hideDeviceKeyboard('pressKey', 'Done');
    * ```
    *
-   * @param  strategy  desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+   * @param {'tapOutside' | 'pressKey'} strategy  desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
    *
    * Appium: support Android and iOS
    */
@@ -838,7 +843,7 @@ class Appium extends Webdriver {
    * I.sendDeviceKeyEvent(3);
    * ```
    *
-   * @param keyValue  Device specific key value
+   * @param {number} keyValue  Device specific key value
    *
    * Appium: support only Android
    */
@@ -912,10 +917,10 @@ class Appium extends Webdriver {
    *
    * [See complete reference](http://webdriver.io/api/mobile/swipe.html)
    *
-   * @param locator
-   * @param xoffset
-   * @param yoffset
-   * @param speed (optional), 1000 by default
+   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {number} xoffset
+   * @param {number} yoffset
+   * @param {number} [speed=1000] (optional), 1000 by default
    *
    * Appium: support Android and iOS
    */
@@ -933,8 +938,8 @@ class Appium extends Webdriver {
    * I.performswipe(100,200);
    * ```
    *
-   * @param from
-   * @param to
+   * @param {number} from
+   * @param {number} to
    *
    * Appium: support Android and iOS
    */
@@ -964,9 +969,9 @@ class Appium extends Webdriver {
    * I.swipeDown(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param locator
-   * @param yoffset (optional)
-   * @param speed (optional), 1000 by default
+   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {number} [yoffset] (optional)
+   * @param {number} [speed=1000] (optional), 1000 by default
    *
    * Appium: support Android and iOS
    */
@@ -992,9 +997,9 @@ class Appium extends Webdriver {
    * I.swipeLeft(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param locator
-   * @param xoffset (optional)
-   * @param speed (optional), 1000 by default
+   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {number} [xoffset] (optional)
+   * @param {number} [speed=1000] (optional), 1000 by default
    *
    * Appium: support Android and iOS
    */
@@ -1018,9 +1023,9 @@ class Appium extends Webdriver {
    * I.swipeRight(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param locator
-   * @param xoffset (optional)
-   * @param speed (optional), 1000 by default
+   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {number} [xoffset] (optional)
+   * @param {number} [speed=1000] (optional), 1000 by default
    *
    * Appium: support Android and iOS
    */
@@ -1044,9 +1049,9 @@ class Appium extends Webdriver {
    * I.swipeUp(locator, 1200, 1000); // set offset and speed
    * ```
    *
-   * @param locator
-   * @param yoffset (optional)
-   * @param speed (optional), 1000 by default
+   * @param {CodeceptJS.LocatorOrString} locator
+   * @param {number} [yoffset] (optional)
+   * @param {number} [speed=1000] (optional), 1000 by default
    *
    * Appium: support Android and iOS
    */
@@ -1074,12 +1079,12 @@ class Appium extends Webdriver {
    *    500);
    * ```
    *
-   * @param searchableLocator
-   * @param scrollLocator
-   * @param direction
-   * @param timeout
-   * @param offset
-   * @param speed
+   * @param {string} searchableLocator
+   * @param {string} scrollLocator
+   * @param {string} direction
+   * @param {number} timeout
+   * @param {number} offset
+   * @param {number} speed
    *
    * Appium: support Android and iOS
    */
@@ -1268,9 +1273,8 @@ class Appium extends Webdriver {
    * ```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) {
@@ -1289,9 +1293,8 @@ class Appium extends Webdriver {
    * 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) {
@@ -1322,9 +1325,9 @@ class Appium extends Webdriver {
    * 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) {
@@ -1341,8 +1344,8 @@ class Appium extends Webdriver {
    * 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) {
@@ -1357,8 +1360,7 @@ class Appium extends Webdriver {
    * 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) {
     if (this.isWeb) return super.dontSeeElement(locator);
@@ -1374,9 +1376,8 @@ class Appium extends Webdriver {
    * 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) {
@@ -1395,9 +1396,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @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) {
     if (this.isWeb) return super.dontSee(text, context);
@@ -1418,9 +1418,9 @@ class Appium extends Webdriver {
    * // 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) {
@@ -1438,9 +1438,8 @@ class Appium extends Webdriver {
    * ```
    * 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) {
@@ -1455,9 +1454,8 @@ class Appium extends Webdriver {
    * ```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) {
@@ -1465,6 +1463,25 @@ class Appium extends Webdriver {
     return super.grabValueFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * Scroll element into viewport.
+   * 
+   * ```js
+   * I.scrollIntoView('#submit');
+   * I.scrollIntoView('#submit', true);
+   * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {boolean|object} alignToTop (optional) or scrollIntoViewOptions (optional), see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+   * 
+   *
+   * Supported only for web testing
+   */
+  async scrollIntoView(locator, scrollIntoViewOptions) {
+    if (this.isWeb) return super.scrollIntoView(locator, scrollIntoViewOptions);
+  }
+
   /**
    * Verifies that the specified checkbox is checked.
    * 
@@ -1474,8 +1491,8 @@ class Appium extends Webdriver {
    * 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) {
@@ -1490,8 +1507,7 @@ class Appium extends Webdriver {
    * ```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) {
@@ -1509,9 +1525,9 @@ class Appium extends Webdriver {
    * 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) {
@@ -1529,8 +1545,7 @@ class Appium extends Webdriver {
    * 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) {
@@ -1557,11 +1572,10 @@ class Appium extends Webdriver {
    * ```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.
    *
-   * * Supported on only for web testing!
+   * Supported only for web testing
    */
   async selectOption(select, option) {
     if (this.isWeb) return super.selectOption(select, option);
@@ -1577,9 +1591,8 @@ class Appium extends Webdriver {
    * I.waitForElement('.btn.continue', 5); // wait for 5 secs
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec] (optional, `1` by default) time in seconds to wait
    *
    */
   async waitForElement(locator, sec = null) {
@@ -1595,9 +1608,8 @@ class Appium extends Webdriver {
    * I.waitForVisible('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    *
    */
   async waitForVisible(locator, sec = null) {
@@ -1613,9 +1625,8 @@ class Appium extends Webdriver {
    * I.waitForInvisible('#popup');
    * ```
    * 
-   * @param {string|object} locator element located by CSS|XPath|strict locator.
-   * @param {number} sec (optional, `1` by default) time in seconds to wait
-   * {--end--}
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    *
    */
   async waitForInvisible(locator, sec = null) {
@@ -1634,9 +1645,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @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) {