codeceptjs 3.3.5-beta.6 → 3.3.6

package/docs/helpers/Nightmare.md

@@ -20,7 +20,7 @@ Requires `nightmare` 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
 -   `restart`  - restart browser between tests.
@@ -97,12 +97,12 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][3]** 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
@@ -113,8 +113,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` **[string][3]** local file path relative to codecept.json config file.
-    [!] returns a _promise_ which is synchronized internally by recorderDoesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][5])
+-   `pathToFile` **[string][3]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
+    ⚠️ returns a _promise_ which is synchronized internally by recorderDoesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][5])
 
 ### checkOption
 
@@ -133,7 +133,7 @@ I.checkOption('agree', '//form');
 
 -   `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][3]? | [object][4])** (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
 
@@ -148,7 +148,7 @@ I.clearCookie('test');
 #### Parameters
 
 -   `cookie` **[string][3]?** (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
 
@@ -164,7 +164,7 @@ I.clearField('#email');
 
 -   `field`  
 -   `editable` **([string][3] | [object][4])** 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
 
@@ -194,7 +194,7 @@ I.click({css: 'nav a.login'});
 
 -   `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][3]? | [object][4] | 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
 
@@ -210,7 +210,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 -   `text` **[string][3]** which is not present.
 -   `context` **([string][3] | [object][4])?** (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
 
@@ -225,7 +225,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][3] | [object][4])** 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
 
@@ -238,7 +238,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][3]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -253,7 +253,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
 
@@ -266,7 +266,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** 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
 
@@ -279,7 +279,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** 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
 
@@ -288,7 +288,7 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -304,7 +304,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
 
@@ -318,7 +318,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][3]** to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInTitle
 
@@ -331,7 +331,7 @@ I.dontSeeInTitle('Error');
 #### Parameters
 
 -   `text` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### doubleClick
 
@@ -349,7 +349,7 @@ I.doubleClick('.btn.edit');
 
 -   `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][3]? | [object][4])** (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 
 
 ### executeAsyncScript
 
@@ -377,7 +377,7 @@ let val = await I.executeAsyncScript(function(url, done) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
-    [!] returns a _promise_ which is synchronized internally by recorderWrapper for asynchronous [evaluate][7].
+    ⚠️ returns a _promise_ which is synchronized internally by recorderWrapper for asynchronous [evaluate][7].
     Unlike NightmareJS implementation calling `done` will return its first argument.
 -   `fn` **([string][3] | [function][8])** function to be executed in browser context.
 
@@ -410,7 +410,7 @@ let date = await I.executeScript(function(el) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
-    [!] returns a _promise_ which is synchronized internally by recorderWrapper for synchronous [evaluate][7]
+    ⚠️ returns a _promise_ which is synchronized internally by recorderWrapper for synchronous [evaluate][7]
 -   `fn` **([string][3] | [function][8])** function to be executed in browser context.
 
 ### fillField
@@ -433,7 +433,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][3] | [object][4])** text value to fill.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### grabAttributeFrom
 
@@ -713,7 +713,7 @@ I.moveCursorTo('#submit', 5,5);
 -   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][11]** (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
 
@@ -736,7 +736,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
 
@@ -747,7 +747,7 @@ First parameter can be set to `maximize`.
 
 -   `width` **[number][11]** width in pixels or `maximize`.
 -   `height` **[number][11]** height in pixels.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### rightClick
 
@@ -766,11 +766,11 @@ I.rightClick('Click me', '.context');
 
 -   `locator` **([string][3] | [object][4])** clickable element located by CSS|XPath|strict locator.
 -   `context` **([string][3]? | [object][4])** (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
@@ -781,11 +781,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][3]** 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.
 
@@ -798,7 +798,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 -   `fileName` **[string][3]** file name to save.
 -   `fullPage` **[boolean][13]** (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
 
@@ -808,7 +808,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
 
@@ -818,7 +818,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
 
@@ -835,7 +835,7 @@ I.scrollTo('#submit', 5, 5);
 -   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][11]** (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
 
@@ -852,7 +852,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 -   `text` **[string][3]** expected on page.
 -   `context` **([string][3]? | [object][4])** (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
 
@@ -867,7 +867,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][3] | [object][4])** 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
 
@@ -880,7 +880,7 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][3]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeCurrentUrlEquals
 
@@ -896,7 +896,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
 
@@ -910,7 +910,7 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** 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
 
@@ -924,7 +924,7 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** 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
 
@@ -937,7 +937,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][3]** a fragment to check
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -955,7 +955,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
 
@@ -968,7 +968,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][3]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInTitle
 
@@ -981,7 +981,7 @@ I.seeInTitle('Home Page');
 #### Parameters
 
 -   `text` **[string][3]** text value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfElements
 
@@ -996,7 +996,7 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][11]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfVisibleElements
 
@@ -1011,7 +1011,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][11]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### selectOption
 
@@ -1038,7 +1038,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][3] | [Array][10]&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
 
@@ -1059,7 +1059,7 @@ I.setCookie([
 #### Parameters
 
 -   `cookie` **(Cookie | [Array][10]&lt;Cookie>)** a cookie object or array of cookie objects.
-    [!] returns a _promise_ which is synchronized internally by recorderWrapper for `.cookies.set(cookie)`.
+    ⚠️ returns a _promise_ which is synchronized internally by recorderWrapper for `.cookies.set(cookie)`.
     [See more][14]
 
 ### triggerMouseEvent
@@ -1094,7 +1094,7 @@ I.uncheckOption('agree', '//form');
 
 -   `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][3]? | [object][4])** (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 
 
 ### wait
 
@@ -1107,7 +1107,7 @@ I.wait(2); // wait 2 secs
 #### Parameters
 
 -   `sec` **[number][11]** number of second to wait.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForDetached
 
@@ -1122,7 +1122,7 @@ I.waitForDetached('#popup');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (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 
 
 ### waitForElement
 
@@ -1138,7 +1138,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]?** (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
 
@@ -1160,7 +1160,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 -   `fn` **([string][3] | [function][8])** to be executed in browser context.
 -   `argsOrSec` **([Array][10]&lt;any> | [number][11])?** (optional, `1` by default) arguments for function or seconds. 
 -   `sec` **[number][11]?** (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
 
@@ -1175,7 +1175,7 @@ I.waitForInvisible('#popup');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (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
 
@@ -1193,7 +1193,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `text` **[string][3]** to wait for.
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 -   `context` **([string][3] | [object][4])?** (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
 
@@ -1208,7 +1208,7 @@ I.waitForVisible('#popup');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (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
 
@@ -1223,7 +1223,7 @@ I.waitToHide('#popup');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (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 
 
 [1]: https://github.com/segmentio/nightmare