codeceptjs 3.5.10 → 3.5.11

package/docs/build/Appium.js

@@ -1058,7 +1058,7 @@ 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
@@ -1113,7 +1113,7 @@ 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>}
@@ -1142,7 +1142,7 @@ 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>}
@@ -1169,7 +1169,7 @@ 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>}
@@ -1196,7 +1196,7 @@ 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>}
@@ -1440,7 +1440,7 @@ class Appium extends Webdriver {
    * // typing secret
    * I.appendField('password', secret('123456'));
    * ```
-   * @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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
@@ -1462,8 +1462,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1496,8 +1496,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 | null} [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 | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1516,7 +1516,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1533,7 +1533,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    */
@@ -1551,8 +1551,8 @@ 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 {CodeceptJS.StringOrSecret} value value to check.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} value value to check.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1573,7 +1573,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    */
@@ -1596,8 +1596,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1616,7 +1616,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
    * 
    *
@@ -1635,7 +1635,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
    * 
    *
@@ -1653,7 +1653,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) {
@@ -1671,7 +1671,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
    * 
@@ -1689,7 +1689,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
    * 
@@ -1706,7 +1706,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
    * 
    *
@@ -1724,7 +1724,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
    * 
    *
@@ -1758,8 +1758,8 @@ class Appium extends Webdriver {
    * I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
    * ```
    * 
-   * @param {LocatorOrString} locator located by CSS|XPath|strict locator.
-   * @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+   * @param {string | object} locator located by CSS|XPath|strict locator.
+   * @param {ScrollIntoViewOptions|boolean} scrollIntoViewOptions either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1778,7 +1778,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1795,7 +1795,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1815,8 +1815,8 @@ 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 {CodeceptJS.StringOrSecret} value value to check.
+   * @param {string | object} field located by label|name|CSS|XPath|strict locator.
+   * @param {string | object} value value to check.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1837,7 +1837,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *
@@ -1866,7 +1866,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
@@ -1887,7 +1887,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
    * @returns {void} automatically synchronized promise through #recorder
    * 
@@ -1906,7 +1906,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
    * @returns {void} automatically synchronized promise through #recorder
    * 
@@ -1925,7 +1925,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
    * @returns {void} automatically synchronized promise through #recorder
    * 
@@ -1948,7 +1948,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.
    * @returns {void} automatically synchronized promise through #recorder
    * 
    *

package/docs/build/Expect.js

@@ -20,7 +20,7 @@ chai.use(require('chai-match-pattern'));
  *{
  *   helpers: {
  *     Playwright: {...},
- *     ExpectHelper: {},
+ *     Expect: {},
  *   }
  *}
  * ```
@@ -32,7 +32,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -44,7 +44,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -56,7 +56,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
 
      */
   expectDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
@@ -69,7 +69,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -81,7 +81,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectContain(actualValue, expectedValueToContain, customErrorMsg = '') {
     // @ts-ignore
@@ -95,7 +95,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotContain(
     actualValue,
@@ -113,7 +113,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectStartsWith(actualValue, expectedValueToStartWith, customErrorMsg = '') {
     // @ts-ignore
@@ -127,7 +127,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotStartsWith(
     actualValue,
@@ -144,7 +144,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEndsWith(actualValue, expectedValueToEndWith, customErrorMsg = '') {
     // @ts-ignore
@@ -157,7 +157,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToNotEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEndsWith(
     actualValue,
@@ -174,7 +174,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
     // @ts-ignore
@@ -186,7 +186,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      * @param {*} ajvOptions Pass AJV options
      */
   expectJsonSchemaUsingAJV(
@@ -204,7 +204,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -215,7 +215,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasAProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -226,7 +226,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeA(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -237,7 +237,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeAn(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -248,7 +248,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} regex
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchRegex(targetData, regex, customErrorMsg = '') {
     // @ts-ignore
@@ -259,7 +259,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} length
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthOf(targetData, length, customErrorMsg = '') {
     // @ts-ignore
@@ -269,7 +269,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEmpty(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -279,7 +279,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectTrue(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -289,7 +289,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectFalse(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -299,8 +299,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} aboveThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} aboveThan
+     * @param {*} [customErrorMsg]
      */
   expectAbove(targetData, aboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -310,8 +310,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} belowThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} belowThan
+     * @param {*} [customErrorMsg]
      */
   expectBelow(targetData, belowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -322,7 +322,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthAboveThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthAboveThan(targetData, lengthAboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -335,7 +335,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthBelowThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthBelowThan(targetData, lengthBelowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -348,7 +348,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqualIgnoreCase(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -362,7 +362,7 @@ class ExpectHelper {
      * expects members of two arrays are deeply equal
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepMembers(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -376,7 +376,7 @@ class ExpectHelper {
      * expects an array to be a superset of another array
      * @param {*} superset
      * @param {*} set
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepIncludeMembers(superset, set, customErrorMsg = '') {
     // @ts-ignore
@@ -391,7 +391,7 @@ class ExpectHelper {
      * @param {*} actualValue
      * @param {*} expectedValue
      * @param {*} fieldsToExclude
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepEqualExcluding(
     actualValue,
@@ -410,7 +410,7 @@ class ExpectHelper {
      * expects a JSON object matches a provided pattern
      * @param {*} actualValue
      * @param {*} expectedPattern
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchesPattern(actualValue, expectedPattern, customErrorMsg = '') {
     // @ts-ignore