codeceptjs 3.3.5 → 3.3.6

package/docs/helpers/TestCafe.md

@@ -20,7 +20,7 @@ Requires `testcafe` package to be installed.
 
 ## 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`:  - show browser window.
@@ -122,12 +122,12 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][4]** text value to append.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### attachFile
 
 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
@@ -138,8 +138,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 #### Parameters
 
 -   `field`  
--   `pathToFile` **[string][4]** local file path relative to codecept.json config file.
-    [!] returns a _promise_ which is synchronized internally by recorder
+-   `pathToFile` **[string][4]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 -   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 
 ### checkOption
@@ -159,7 +159,7 @@ I.checkOption('agree', '//form');
 
 -   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][4]? | [object][5])** (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 
 
 ### clearCookie
 
@@ -175,7 +175,7 @@ I.clearCookie('test');
 
 -   `cookieName`  
 -   `cookie` **[string][4]?** (optional, `null` by default) cookie name
-    [!] returns a _promise_ which is synchronized internally by recorder 
+    ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### clearField
 
@@ -191,7 +191,7 @@ I.clearField('#email');
 
 -   `field`  
 -   `editable` **([string][4] | [object][5])** 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.
 
 ### click
 
@@ -221,7 +221,7 @@ I.click({css: 'nav a.login'});
 
 -   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][4]? | [object][5] | 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 
 
 ### dontSee
 
@@ -237,7 +237,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 -   `text` **[string][4]** which is not present.
 -   `context` **([string][4] | [object][5])?** (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 
 
 ### dontSeeCheckboxIsChecked
 
@@ -252,7 +252,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][4] | [object][5])** 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
 
 ### dontSeeCookie
 
@@ -265,7 +265,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][4]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -280,7 +280,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
 
@@ -293,7 +293,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElementInDOM
 
@@ -306,7 +306,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInCurrentUrl
 
@@ -315,7 +315,7 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -331,7 +331,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
 
@@ -345,7 +345,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][4]** to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### doubleClick
 
@@ -363,7 +363,7 @@ I.doubleClick('.btn.edit');
 
 -   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][4]? | [object][5])** (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 
 
 ### executeScript
 
@@ -395,7 +395,7 @@ let date = await I.executeScript(function(el) {
 
 -   `fn` **([string][4] | [function][6])** function to be executed in browser context.
 -   `args` **...any** to be passed to function.
-    [!] returns a _promise_ which is synchronized internally by recorderIf a function returns a Promise It will wait for it resolution.
+    ⚠️ returns a _promise_ which is synchronized internally by recorderIf a function returns a Promise It will wait for it resolution.
 
 ### fillField
 
@@ -417,7 +417,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][4] | [object][5])** text value to fill.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### grabAttributeFrom
 
@@ -606,7 +606,7 @@ I.moveCursorTo('#submit', 5,5);
 -   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][9]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][9]** (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 
 
 ### pressKey
 
@@ -623,7 +623,7 @@ I.pressKey(['Control','a']);
 #### Parameters
 
 -   `key` **([string][4] | [Array][8]&lt;[string][4]>)** 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
 
 
 [Valid key names](https://w3c.github.io/webdriver/#keyboard-actions) are:
@@ -666,7 +666,7 @@ Reload the current page.
 I.refreshPage();
 ```
 
-[!] returns a _promise_ which is synchronized internally by recorder
+⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### resizeWindow
 
@@ -677,7 +677,7 @@ First parameter can be set to `maximize`.
 
 -   `width` **[number][9]** width in pixels or `maximize`.
 -   `height` **[number][9]** height in pixels.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### rightClick
 
@@ -696,11 +696,11 @@ I.rightClick('Click me', '.context');
 
 -   `locator` **([string][4] | [object][5])** clickable element located by CSS|XPath|strict locator.
 -   `context` **([string][4]? | [object][5])** (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 
 
 ### saveElementScreenshot
 
-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
@@ -711,11 +711,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][4]** file name to save.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### saveScreenshot
 
-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.
 
@@ -728,7 +728,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 -   `fileName` **[string][4]** file name to save.
 -   `fullPage` **[boolean][11]** (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 
 
 ### scrollPageToBottom
 
@@ -738,7 +738,7 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-[!] returns a _promise_ which is synchronized internally by recorder
+⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### scrollPageToTop
 
@@ -748,7 +748,7 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-[!] returns a _promise_ which is synchronized internally by recorder
+⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### scrollTo
 
@@ -765,7 +765,7 @@ I.scrollTo('#submit', 5, 5);
 -   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][9]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][9]** (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 
 
 ### see
 
@@ -782,7 +782,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 -   `text` **[string][4]** expected on page.
 -   `context` **([string][4]? | [object][5])** (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 
 
 ### seeCheckboxIsChecked
 
@@ -797,7 +797,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][4] | [object][5])** 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
 
 ### seeCookie
 
@@ -810,7 +810,7 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][4]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeCurrentUrlEquals
 
@@ -826,7 +826,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
 
@@ -840,7 +840,7 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeElementInDOM
 
@@ -854,7 +854,7 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][4] | [object][5])** 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
 
 ### seeInCurrentUrl
 
@@ -867,7 +867,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][4]** a fragment to check
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -885,7 +885,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
 
@@ -898,7 +898,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfVisibleElements
 
@@ -913,7 +913,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `num` **[number][9]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeTextEquals
 
@@ -953,7 +953,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][4] | [Array][8]&lt;any>)** visible text or value of option.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### setCookie
 
@@ -974,7 +974,7 @@ I.setCookie([
 #### Parameters
 
 -   `cookie` **(Cookie | [Array][8]&lt;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
 
 ### switchTo
 
@@ -988,7 +988,7 @@ I.switchTo(); // switch back to main page
 #### Parameters
 
 -   `locator` **([string][4]? | [object][5])** (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 
 
 ### uncheckOption
 
@@ -1007,7 +1007,7 @@ I.uncheckOption('agree', '//form');
 
 -   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][4]? | [object][5])** (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 
 
 ### useTestCafeTo
 
@@ -1040,7 +1040,7 @@ I.wait(2); // wait 2 secs
 #### Parameters
 
 -   `sec` **[number][9]** number of second to wait.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForElement
 
@@ -1056,7 +1056,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][9]?** (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
 
 ### waitForFunction
 
@@ -1078,7 +1078,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 -   `fn` **([string][4] | [function][6])** to be executed in browser context.
 -   `argsOrSec` **([Array][8]&lt;any> | [number][9])?** (optional, `1` by default) arguments for function or seconds. 
 -   `sec` **[number][9]?** (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 
 
 ### waitForInvisible
 
@@ -1093,7 +1093,7 @@ I.waitForInvisible('#popup');
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][9]** (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 
 
 ### waitForText
 
@@ -1111,7 +1111,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `text` **[string][4]** to wait for.
 -   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 -   `context` **([string][4] | [object][5])?** (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 
 
 ### waitForVisible
 
@@ -1126,7 +1126,7 @@ I.waitForVisible('#popup');
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][9]** (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 
 
 ### waitInUrl
 
@@ -1140,7 +1140,7 @@ I.waitInUrl('/info', 2);
 
 -   `urlPart` **[string][4]** value to check.
 -   `sec` **[number][9]** (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 
 
 ### waitNumberOfVisibleElements
 
@@ -1155,7 +1155,7 @@ I.waitNumberOfVisibleElements('a', 3);
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `num` **[number][9]** number of elements.
 -   `sec` **[number][9]** (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 
 
 ### waitToHide
 
@@ -1170,7 +1170,7 @@ I.waitToHide('#popup');
 
 -   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][9]** (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 
 
 ### waitUrlEquals
 
@@ -1185,7 +1185,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 -   `urlPart` **[string][4]** value to check.
 -   `sec` **[number][9]** (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 
 
 ## getPageUrl