codeceptjs 2.1.3 → 2.2.1

package/docs/build/Appium.js

@@ -116,7 +116,7 @@ class Appium extends Webdriver {
     const defaults = {
       // webdriverio defaults
       protocol: 'http',
-      host: '0.0.0.0',
+      hostname: '0.0.0.0', // webdriverio specs
       port: 4723,
       path: '/wd/hub',
 
@@ -146,6 +146,8 @@ class Appium extends Webdriver {
     config.capabilities.platformName = config.platform || config.capabilities.platformName;
     config.waitForTimeout /= 1000; // convert to seconds
 
+    // [CodeceptJS compatible] transform host to hostname
+    config.hostname = config.host || config.hostname;
 
     if (!config.app && config.capabilities.browserName) {
       this.isWeb = true;
@@ -1220,13 +1222,14 @@ class Appium extends Webdriver {
 
   /**
    * Appends text to a input field or textarea.
-Field is located by name, label, CSS or XPath
-
-```js
-I.appendField('#myTextField', 'appended');
-```
-@param field located by label|name|CSS|XPath|strict locator
-@param value text value to append.
+   * Field is located by name, label, CSS or XPath
+   * 
+   * ```js
+   * I.appendField('#myTextField', 'appended');
+   * ```
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator
+   * @param {string} value text value to append.
+   * {--end--}
    *
    */
   async appendField(field, value) {
@@ -1236,17 +1239,18 @@ I.appendField('#myTextField', 'appended');
 
   /**
    * Selects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.checkOption('#agree');
-I.checkOption('I Agree to Terms and Conditions');
-I.checkOption('agree', '//form');
-```
-@param field checkbox located by label | name | CSS | XPath | strict locator.
-@param context (optional) element located by CSS | XPath | strict locator.
+   * Element is located by label or name or CSS or XPath.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * I.checkOption('#agree');
+   * 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--}
    *
    */
   async checkOption(field) {
@@ -1256,29 +1260,30 @@ I.checkOption('agree', '//form');
 
   /**
    * Perform a click on a link or a button, given by a locator.
-If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
-For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
-For images, the "alt" attribute and inner text of any parent links are searched.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-// simple link
-I.click('Logout');
-// button of form
-I.click('Submit');
-// CSS button
-I.click('#form input[type=submit]');
-// XPath
-I.click('//form/*[@type=submit]');
-// link in context
-I.click('Logout', '#nav');
-// using strict locator
-I.click({css: 'nav a.login'});
-```
-
-@param locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param context (optional) element to search in CSS|XPath|Strict locator.
+   * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+   * For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+   * For images, the "alt" attribute and inner text of any parent links are searched.
+   * 
+   * The second parameter is a context (CSS or XPath locator) to narrow the search.
+   * 
+   * ```js
+   * // simple link
+   * I.click('Logout');
+   * // button of form
+   * I.click('Submit');
+   * // CSS button
+   * I.click('#form input[type=submit]');
+   * // XPath
+   * I.click('//form/*[@type=submit]');
+   * // link in context
+   * I.click('Logout', '#nav');
+   * // using strict locator
+   * 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--}
    *
    */
   async click(locator, context) {
@@ -1288,8 +1293,15 @@ I.click({css: 'nav a.login'});
 
   /**
    * Verifies that the specified checkbox is not checked.
-
-@param field located by label|name|CSS|XPath|strict locator.
+   * 
+   * ```js
+   * I.dontSeeeCheckboxIsChedcked('#agree'); // located by ID
+   * I.dontSeeeCheckboxIsChedcked('I agree to terms'); // located by label
+   * I.dontSeeeCheckboxIsChedcked('agree'); // located by name
+   * ```
+   * 
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * {--end--}
    *
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1299,21 +1311,31 @@ I.click({css: 'nav a.login'});
 
   /**
    * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
-
-@param locator located by CSS|XPath|Strict locator.
-   *
+   * 
+   * ```js
+   * I.dontSeeElement('.modal'); // modal is not shown
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|Strict locator.
+   * {--end--}
    */
-  async dontSeeElement(locator, context) {
+  async dontSeeElement(locator) {
     if (this.isWeb) return super.dontSeeElement(locator);
     return super.dontSeeElement(parseLocator.call(this, locator));
   }
 
   /**
    * Checks that value of input field or textare doesn't equal to given value
-Opposite to `seeInField`.
-
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+   * Opposite to `seeInField`.
+   * 
+   * ```js
+   * I.dontSeeInField('email', 'user@user.com'); // field by name
+   * 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 {string} value value to check.
+   * {--end--}
    *
    */
   async dontSeeInField(field, value) {
@@ -1324,37 +1346,40 @@ Opposite to `seeInField`.
 
   /**
    * Opposite to `see`. Checks that a text is not present on a page.
-Use context parameter to narrow down the search.
-
-```js
-I.dontSee('Login'); // assume we are already logged in
-```
-@param text is not present.
-@param context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+   * Use context parameter to narrow down the search.
+   * 
+   * ```js
+   * I.dontSee('Login'); // assume we are already logged in.
+   * I.dontSee('Login', '.nav'); // no login inside .nav element
+   * ```
+   * 
+   * @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--}
    */
-  async dontSee(text, context) {
+  async dontSee(text, context = null) {
     if (this.isWeb) return super.dontSee(text, context);
     return super.dontSee(text, parseLocator.call(this, context));
   }
 
   /**
    * Fills a text field or textarea, after clearing its value, with the given string.
-Field is located by name, label, CSS, or XPath.
-
-```js
-// by label
-I.fillField('Email', 'hello@world.com');
-// by name
-I.fillField('password', secret('123456'));
-// by CSS
-I.fillField('form#login input[name=username]', 'John');
-// or by strict locator
-I.fillField({css: 'form#login input[name=username]'}, 'John');
-```
-@param field located by label|name|CSS|XPath|strict locator.
-@param value text value to fill.
-
+   * Field is located by name, label, CSS, or XPath.
+   * 
+   * ```js
+   * // by label
+   * I.fillField('Email', 'hello@world.com');
+   * // by name
+   * I.fillField('password', secret('123456'));
+   * // by CSS
+   * I.fillField('form#login input[name=username]', 'John');
+   * // 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 {string} value text value to fill.
+   * {--end--}
    *
    */
   async fillField(field, value) {
@@ -1365,14 +1390,16 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
   /**
    * Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let pin = await I.grabTextFrom('#pin');
-```
-If multiple elements found returns an array of texts.
-
-@param locator element located by CSS|XPath|strict locator.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let pin = await I.grabTextFrom('#pin');
+   * ```
+   * If multiple elements found returns an array of texts.
+   * 
+   * @param locator element located by CSS|XPath|strict locator.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
    *
    */
   async grabTextFrom(locator) {
@@ -1382,12 +1409,14 @@ If multiple elements found returns an array of texts.
 
   /**
    * Retrieves a value from a form element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let email = await I.grabValueFrom('input[name=email]');
-```
-@param locator field located by label|name|CSS|XPath|strict locator.
+   * Resumes test execution, so **should be used inside async function with `await`** operator.
+   * 
+   * ```js
+   * let email = await I.grabValueFrom('input[name=email]');
+   * ```
+   * @param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+   * @returns {Promise<string>} attribute value
+   * {--end--}
    *
    */
   async grabValueFrom(locator) {
@@ -1397,13 +1426,15 @@ let email = await I.grabValueFrom('input[name=email]');
 
   /**
    * Verifies that the specified checkbox is checked.
-
-```js
-I.seeCheckboxIsChecked('Agree');
-I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
-I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
-```
-@param field located by label|name|CSS|XPath|strict locator.
+   * 
+   * ```js
+   * I.seeCheckboxIsChecked('Agree');
+   * I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
+   * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
+   * ```
+   * 
+   * @param {string|object} field located by label|name|CSS|XPath|strict locator.
+   * {--end--}
    *
    */
   async seeCheckboxIsChecked(field) {
@@ -1413,12 +1444,13 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
   /**
    * Checks that a given Element is visible
-Element is located by CSS or XPath.
-
-```js
-I.seeElement('#modal');
-```
-@param locator located by CSS|XPath|strict locator.
+   * Element is located by CSS or XPath.
+   * 
+   * ```js
+   * I.seeElement('#modal');
+   * ```
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * {--end--}
    *
    */
   async seeElement(locator) {
@@ -1428,16 +1460,17 @@ I.seeElement('#modal');
 
   /**
    * Checks that the given input field or textarea equals to given value.
-For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
-
-```js
-I.seeInField('Username', 'davert');
-I.seeInField({css: 'form textarea'},'Type your comment here');
-I.seeInField('form input[type=hidden]','hidden_value');
-I.seeInField('#searchform input','Search');
-```
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+   * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
+   * 
+   * ```js
+   * I.seeInField('Username', 'davert');
+   * I.seeInField({css: 'form textarea'},'Type your comment here');
+   * 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 {string} value value to check.
+   * {--end--}
    *
    */
   async seeInField(field, value) {
@@ -1447,15 +1480,16 @@ I.seeInField('#searchform input','Search');
 
   /**
    * Checks that a page contains a visible text.
-Use context parameter to narrow down the search.
-
-```js
-I.see('Welcome'); // text welcome on a page
-I.see('Welcome', '.content'); // text inside .content div
-I.see('Register', {css: 'form.register'}); // use strict locator
-```
-@param text expected on page.
-@param context (optional) element located by CSS|Xpath|strict locator in which to search for text.
+   * Use context parameter to narrow down the search.
+   * 
+   * ```js
+   * I.see('Welcome'); // text welcome on a page
+   * I.see('Welcome', '.content'); // text inside .content div
+   * 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--}
    *
    */
   async see(text, context) {
@@ -1465,25 +1499,26 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
   /**
    * Selects an option in a drop-down select.
-Field is searched by label | name | CSS | XPath.
-Option is selected by visible text or by value.
-
-```js
-I.selectOption('Choose Plan', 'Monthly'); // select by label
-I.selectOption('subscription', 'Monthly'); // match option by text
-I.selectOption('subscription', '0'); // or by value
-I.selectOption('//form/select[@name=account]','Premium');
-I.selectOption('form select[name=account]', 'Premium');
-I.selectOption({css: 'form select[name=account]'}, 'Premium');
-```
-
-Provide an array for the second argument to select multiple options.
-
-```js
-I.selectOption('Which OS do you use?', ['Android', 'iOS']);
-```
-@param select field located by label|name|CSS|XPath|strict locator.
-@param option visible text or value of option.
+   * Field is searched by label | name | CSS | XPath.
+   * Option is selected by visible text or by value.
+   * 
+   * ```js
+   * I.selectOption('Choose Plan', 'Monthly'); // select by label
+   * I.selectOption('subscription', 'Monthly'); // match option by text
+   * I.selectOption('subscription', '0'); // or by value
+   * I.selectOption('//form/select[@name=account]','Premium');
+   * I.selectOption('form select[name=account]', 'Premium');
+   * I.selectOption({css: 'form select[name=account]'}, 'Premium');
+   * ```
+   * 
+   * Provide an array for the second argument to select multiple options.
+   * 
+   * ```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--}
    *
    * * Supported on only for web testing!
    */
@@ -1494,15 +1529,16 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
   /**
    * Waits for element to be present on page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForElement('.btn.continue');
-I.waitForElement('.btn.continue', 5); // wait for 5 secs
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * I.waitForElement('.btn.continue');
+   * 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--}
    *
    */
   async waitForElement(locator, sec = null) {
@@ -1512,14 +1548,15 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
   /**
    * Waits for an element to become visible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitForVisible('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * 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--}
    *
    */
   async waitForVisible(locator, sec = null) {
@@ -1529,14 +1566,15 @@ I.waitForVisible('#popup');
 
   /**
    * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```
-I.waitForInvisible('#popup');
-```
-
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+   * Element can be located by CSS or XPath.
+   * 
+   * ```js
+   * 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--}
    *
    */
   async waitForInvisible(locator, sec = null) {
@@ -1546,17 +1584,18 @@ I.waitForInvisible('#popup');
 
   /**
    * Waits for a text to appear (by default waits for 1sec).
-Element can be located by CSS or XPath.
-Narrow down search results by providing context.
-
-```js
-I.waitForText('Thank you, form has been submitted');
-I.waitForText('Thank you, form has been submitted', 5, '#modal');
-```
-
-@param text to wait for.
-@param sec (optional) time in seconds to wait.
-@param context (optional) element located by CSS|XPath|strict locator.
+   * Element can be located by CSS or XPath.
+   * Narrow down search results by providing context.
+   * 
+   * ```js
+   * I.waitForText('Thank you, form has been submitted');
+   * I.waitForText('Thank you, form has been submitted', 5, '#modal');
+   * ```
+   * 
+   * @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--}
    *
    */
   async waitForText(text, sec = null, context = null) {