codeceptjs 3.3.5 → 3.3.7-beta.1

package/docs/build/REST.js

@@ -9,7 +9,7 @@ const { beautify } = require('../utils');
  *
  * @typedef RESTConfig
  * @type {object}
- * @prop {string} endpoint - API base URL
+ * @prop {string} [endpoint] - API base URL
  * @prop {boolean} [prettyPrintJson=false] - pretty print json for response/request on console logs
  * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default
  * @prop {object} [defaultHeaders] - a list of default headers
@@ -138,7 +138,7 @@ class REST extends Helper {
 
     if (request.data instanceof Secret) {
       _debugRequest.data = '*****';
-      request.data = typeof request.data === 'object' ? { ...request.data.toString() } : request.data.toString();
+      request.data = (typeof request.data === 'object' && !(request.data instanceof Secret)) ? { ...request.data.toString() } : request.data.toString();
     }
 
     if ((typeof request.data) === 'string') {

package/docs/build/TestCafe.js

@@ -42,7 +42,7 @@ const getHtmlSource = t => ClientFunction(() => document.getElementsByTagName('h
  *
  * ## Configuration
  *
- * This helper should be configured in codecept.json or codecept.conf.js
+ * This helper should be configured in codecept.conf.ts or codecept.conf.js
  *
  * * `url`: base url of website to be tested
  * * `show`: (optional, default: false) - show browser window.
@@ -351,7 +351,8 @@ class TestCafe extends Helper {
    * 
    * @param {number} width width in pixels or `maximize`.
    * @param {number} height height in pixels.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -386,7 +387,7 @@ class TestCafe extends Helper {
    * 
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
@@ -400,7 +401,8 @@ class TestCafe extends Helper {
    * ```js
    * I.refreshPage();
    * ```
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async refreshPage() {
     // eslint-disable-next-line no-restricted-globals
@@ -417,7 +419,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForVisible(locator, sec) {
@@ -444,7 +447,8 @@ class TestCafe extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async fillField(field, value) {
     const els = await findFields.call(this, field);
@@ -464,7 +468,8 @@ class TestCafe extends Helper {
    * I.clearField('#email');
    * ```
    * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder.
+   * 
    */
   async clearField(field) {
     const els = await findFields.call(this, field);
@@ -486,7 +491,8 @@ class TestCafe extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async appendField(field, value) {
@@ -501,7 +507,7 @@ class TestCafe extends Helper {
 
   /**
    * Attaches a file to element located by label, name, CSS or XPath
-   * Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
+   * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
    * File will be uploaded to remote system (if tests are running remotely).
    * 
    * ```js
@@ -510,8 +516,9 @@ class TestCafe extends Helper {
    * ```
    * 
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * @param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async attachFile(field, pathToFile) {
@@ -537,7 +544,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string|string[]} key key or array of keys to press.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    * {{ keys }}
    */
@@ -561,7 +569,8 @@ class TestCafe extends Helper {
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
@@ -586,7 +595,8 @@ class TestCafe extends Helper {
    * 
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async doubleClick(locator, context = null) {
@@ -617,7 +627,8 @@ class TestCafe extends Helper {
    * 
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async rightClick(locator, context = null) {
@@ -647,7 +658,8 @@ class TestCafe extends Helper {
    * ```
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async checkOption(field, context = null) {
     const el = await findCheckable.call(this, field, context);
@@ -670,7 +682,8 @@ class TestCafe extends Helper {
    * ```
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async uncheckOption(field, context = null) {
     const el = await findCheckable.call(this, field, context);
@@ -692,7 +705,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
@@ -708,7 +722,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
@@ -735,7 +750,8 @@ class TestCafe extends Helper {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async selectOption(select, option) {
     const els = await findFields.call(this, select);
@@ -787,7 +803,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url a fragment to check
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeInCurrentUrl(url) {
     stringIncludes('url').assert(url, await getPageUrl(this.t)().catch(mapError));
@@ -797,7 +814,8 @@ class TestCafe extends Helper {
    * Checks that current url does not contain a provided fragment.
    * 
    * @param {string} url value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeInCurrentUrl(url) {
     stringIncludes('url').negate(url, await getPageUrl(this.t)().catch(mapError));
@@ -814,7 +832,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeCurrentUrlEquals(url) {
     urlEquals(this.options.url).assert(url, await getPageUrl(this.t)().catch(mapError));
@@ -830,7 +849,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} url value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeCurrentUrlEquals(url) {
     urlEquals(this.options.url).negate(url, await getPageUrl(this.t)().catch(mapError));
@@ -847,7 +867,8 @@ class TestCafe extends Helper {
    * ```
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async see(text, context = null) {
@@ -874,7 +895,8 @@ class TestCafe extends Helper {
    * 
    * @param {string} text which is not present.
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async dontSee(text, context = null) {
@@ -898,7 +920,8 @@ class TestCafe extends Helper {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeElement(locator) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
@@ -915,7 +938,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeElement(locator) {
     const exists = (await findElements.call(this, this.context, locator)).filterVisible().exists;
@@ -932,7 +956,8 @@ class TestCafe extends Helper {
    * I.seeElementInDOM('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeElementInDOM(locator) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
@@ -949,7 +974,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeElementInDOM(locator) {
     const exists = (await findElements.call(this, this.context, locator)).exists;
@@ -968,7 +994,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async seeNumberOfVisibleElements(locator, num) {
@@ -1006,7 +1033,8 @@ class TestCafe extends Helper {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeInField(field, value) {
     // const expectedValue = findElements.call(this, this.context, field).value;
@@ -1030,7 +1058,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeInField(field, value) {
     // const expectedValue = findElements.call(this, this.context, field).value;
@@ -1064,7 +1093,8 @@ class TestCafe extends Helper {
    * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
    * ```
    * @param {string} text value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async seeInSource(text) {
     const source = await getHtmlSource(this.t)();
@@ -1079,7 +1109,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeInSource(text) {
     const source = await getHtmlSource(this.t)();
@@ -1087,7 +1118,7 @@ class TestCafe extends Helper {
   }
 
   /**
-   * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+   * Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
    * Filename is relative to output folder.
    * 
    * ```js
@@ -1096,7 +1127,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {string} fileName file name to save.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async saveElementScreenshot(locator, fileName) {
@@ -1111,7 +1143,7 @@ class TestCafe extends Helper {
   }
 
   /**
-   * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+   * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
    * Filename is relative to output folder.
    * Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
    * 
@@ -1122,7 +1154,8 @@ class TestCafe extends Helper {
    * 
    * @param {string} fileName file name to save.
    * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   // TODO Implement full page screenshots
   async saveScreenshot(fileName) {
@@ -1141,7 +1174,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {number} sec number of second to wait.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async wait(sec) {
     return new Promise(((done) => {
@@ -1175,7 +1209,7 @@ class TestCafe extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
    * If a function returns a Promise It will wait for it resolution.
@@ -1388,7 +1422,8 @@ class TestCafe extends Helper {
    * ```js
    * I.scrollPageToTop();
    * ```
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   scrollPageToTop() {
     return ClientFunction(() => window.scrollTo(0, 0)).with({ boundTestRun: this.t })().catch(mapError);
@@ -1400,7 +1435,8 @@ class TestCafe extends Helper {
    * ```js
    * I.scrollPageToBottom();
    * ```
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   scrollPageToBottom() {
     return ClientFunction(() => {
@@ -1425,7 +1461,8 @@ class TestCafe extends Helper {
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1464,7 +1501,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async switchTo(locator) {
     if (Number.isInteger(locator)) {
@@ -1497,7 +1535,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async setCookie(cookie) {
     if (Array.isArray(cookie)) {
@@ -1522,7 +1561,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async seeCookie(name) {
@@ -1538,7 +1578,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {string} name cookie name.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeCookie(name) {
     const cookie = await this.grabCookie(name);
@@ -1588,7 +1629,8 @@ class TestCafe extends Helper {
    * ```
    * 
    * @param {?string} [cookie=null] (optional, `null` by default) cookie name
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async clearCookie(cookieName) {
     const clearCookies = ClientFunction(() => {
@@ -1616,7 +1658,8 @@ class TestCafe extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitInUrl(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1642,7 +1685,8 @@ class TestCafe extends Helper {
    * 
    * @param {string} urlPart value to check.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitUrlEquals(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1680,7 +1724,8 @@ class TestCafe extends Helper {
    * @param {string|function} fn to be executed in browser context.
    * @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
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -1708,7 +1753,8 @@ class TestCafe extends Helper {
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} num number of elements.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitNumberOfVisibleElements(locator, num, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1730,7 +1776,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitForElement(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1750,7 +1797,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitToHide(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1770,7 +1818,8 @@ class TestCafe extends Helper {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async waitForInvisible(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1793,7 +1842,8 @@ class TestCafe extends Helper {
    * @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.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForText(text, sec = null, context = null) {