codeceptjs 3.3.5 → 3.3.7-beta.1

package/docs/helpers/Puppeteer.md

@@ -302,7 +302,7 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][6]** text value to append.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -311,7 +311,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 ### 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
@@ -322,8 +322,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 #### Parameters
 
 -   `locator` **([string][6] | [object][4])** field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` **[string][6]** local file path relative to codecept.json config file.
-    [!] returns a _promise_ which is synchronized internally by recorder> ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][7], downgrade to 2.0.0 if you face it.
+-   `pathToFile` **[string][6]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
+    ⚠️ returns a _promise_ which is synchronized internally by recorder> ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][7], downgrade to 2.0.0 if you face it.
 
 ### cancelPopup
 
@@ -346,7 +346,7 @@ I.checkOption('agree', '//form');
 
 -   `field` **([string][6] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][6]? | [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
 
@@ -362,7 +362,7 @@ I.clearCookie('test');
 
 -   `name`  
 -   `cookie` **[string][6]?** (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
 
@@ -378,7 +378,7 @@ I.clearField('#email');
 
 -   `field`  
 -   `editable` **([string][6] | [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
 
@@ -408,7 +408,7 @@ I.click({css: 'nav a.login'});
 
 -   `locator` **([string][6] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -426,7 +426,7 @@ I.clickLink('Logout', '#nav');
 
 -   `locator` **([string][6] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -462,7 +462,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 -   `text` **[string][6]** which is not present.
 -   `context` **([string][6] | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -481,7 +481,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][6] | [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
 
@@ -494,7 +494,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 #### Parameters
 
 -   `name` **[string][6]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeCurrentUrlEquals
 
@@ -509,7 +509,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 #### Parameters
 
 -   `url` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
 
@@ -522,8 +522,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][6] | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -540,7 +539,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 #### Parameters
 
 -   `locator` **([string][6] | [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
 
@@ -549,7 +548,7 @@ Checks that current url does not contain a provided fragment.
 #### Parameters
 
 -   `url` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -565,7 +564,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
 
@@ -579,7 +578,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 
 -   `text`  
 -   `value` **[string][6]** to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInTitle
 
@@ -592,7 +591,7 @@ I.dontSeeInTitle('Error');
 #### Parameters
 
 -   `text` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### doubleClick
 
@@ -610,7 +609,7 @@ I.doubleClick('.btn.edit');
 
 -   `locator` **([string][6] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -639,7 +638,7 @@ I.dragAndDrop('#dragHandle', '#container');
 
 -   `srcElement` **([string][6] | [object][4])** located by CSS|XPath|strict locator.
 -   `destElement` **([string][6] | [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
 
 ### dragSlider
 
@@ -655,8 +654,7 @@ I.dragSlider('#slider', -70);
 
 -   `locator` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `offsetX` **[number][8]** position to drag.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -688,7 +686,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 recorderAsynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
+    ⚠️ returns a _promise_ which is synchronized internally by recorderAsynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
 -   `fn` **([string][6] | [function][10])** function to be executed in browser context.
 
 ### executeScript
@@ -720,7 +718,7 @@ let date = await I.executeScript(function(el) {
 #### Parameters
 
 -   `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.
 -   `fn` **([string][6] | [function][10])** function to be executed in browser context.
 
 ### fillField
@@ -743,8 +741,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][6] | [object][4])** text value to fill.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -781,7 +778,7 @@ I.forceClick({css: 'nav a.login'});
 
 -   `locator` **([string][6] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1188,8 +1185,7 @@ I.moveCursorTo('#submit', 5,5);
 -   `locator` **([string][6] | [object][4])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][8]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][8]** (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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1267,7 +1263,7 @@ Some of the supported key names are:
 #### Parameters
 
 -   `key` **([string][6] | [Array][12]&lt;[string][6]>)** key or array of keys to press.
-    [!] returns a _promise_ which is synchronized internally by recorder_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][15]).
+    ⚠️ returns a _promise_ which is synchronized internally by recorder_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][15]).
 
 ### pressKeyDown
 
@@ -1284,7 +1280,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][6]** name of key to press down.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### pressKeyUp
 
@@ -1301,7 +1297,7 @@ I.pressKeyUp('Control');
 #### Parameters
 
 -   `key` **[string][6]** name of key to release.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### refreshPage
 
@@ -1311,7 +1307,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
 
@@ -1322,7 +1318,7 @@ First parameter can be set to `maximize`.
 
 -   `width` **[number][8]** width in pixels or `maximize`.
 -   `height` **[number][8]** height in pixels.
-    [!] returns a _promise_ which is synchronized internally by recorderUnlike other drivers Puppeteer changes the size of a viewport, not the window!
+    ⚠️ returns a _promise_ which is synchronized internally by recorderUnlike other drivers Puppeteer changes the size of a viewport, not the window!
     Puppeteer does not control the window of a browser so it can't adjust its real size.
     It also can't maximize a window.
 
@@ -1343,7 +1339,7 @@ I.rightClick('Click me', '.context');
 
 -   `locator` **([string][6] | [object][4])** clickable element located by CSS|XPath|strict locator.
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1351,7 +1347,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### 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
@@ -1362,11 +1358,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][6]** 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.
 
@@ -1379,7 +1375,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 -   `fileName` **[string][6]** file name to save.
 -   `fullPage` **[boolean][17]** (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
 
@@ -1389,7 +1385,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
 
@@ -1399,7 +1395,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
 
@@ -1416,7 +1412,7 @@ I.scrollTo('#submit', 5, 5);
 -   `locator` **([string][6] | [object][4])** located by CSS|XPath|strict locator.
 -   `offsetX` **[number][8]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][8]** (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
 
@@ -1433,7 +1429,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 -   `text` **[string][6]** expected on page.
 -   `context` **([string][6]? | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1451,8 +1447,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 -   `locator` **([string][6] | [object][4])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][4]** attributes and their values to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1471,7 +1466,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][6] | [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
 
@@ -1484,7 +1479,7 @@ I.seeCookie('Auth');
 #### Parameters
 
 -   `name` **[string][6]** cookie name.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeCssPropertiesOnElements
 
@@ -1498,8 +1493,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 -   `locator` **([string][6] | [object][4])** located by CSS|XPath|strict locator.
 -   `cssProperties` **[object][4]** object with CSS properties and their values to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1519,7 +1513,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 #### Parameters
 
 -   `url` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
 
@@ -1533,8 +1527,7 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][6] | [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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1552,7 +1545,7 @@ I.seeElementInDOM('#modal');
 #### Parameters
 
 -   `locator` **([string][6] | [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
 
@@ -1565,7 +1558,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 #### Parameters
 
 -   `url` **[string][6]** a fragment to check
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -1583,7 +1576,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
 
@@ -1597,7 +1590,7 @@ I.seeInPopup('Popup text');
 #### Parameters
 
 -   `text` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
 
@@ -1610,7 +1603,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 #### Parameters
 
 -   `text` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInTitle
 
@@ -1623,7 +1616,7 @@ I.seeInTitle('Home Page');
 #### Parameters
 
 -   `text` **[string][6]** text value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeNumberOfElements
 
@@ -1638,7 +1631,7 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][8]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1657,7 +1650,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][8]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1675,7 +1668,7 @@ I.seeTextEquals('text', 'h1');
 
 -   `text` **[string][6]** element value to check.
 -   `context` **([string][6] | [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 
 
 ### seeTitleEquals
 
@@ -1688,7 +1681,7 @@ I.seeTitleEquals('Test title.');
 #### Parameters
 
 -   `text` **[string][6]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### selectOption
 
@@ -1715,7 +1708,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][6] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][6] | [Array][12]&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
 
@@ -1736,7 +1729,7 @@ I.setCookie([
 #### Parameters
 
 -   `cookie` **(Cookie | [Array][12]&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
 
@@ -1750,7 +1743,7 @@ I.switchTo(); // switch back to main page
 #### Parameters
 
 -   `locator` **([string][6]? | [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 
 
 ### switchToNextTab
 
@@ -1799,7 +1792,7 @@ I.type(['T', 'E', 'X', 'T']);
 
 -   `keys`  
 -   `delay` **[number][8]?** (optional) delay in ms between key presses
-    [!] returns a _promise_ which is synchronized internally by recorder 
+    ⚠️ returns a _promise_ which is synchronized internally by recorder 
 -   `key` **([string][6] | [Array][12]&lt;[string][6]>)** or array of keys to type.
 
 ### uncheckOption
@@ -1819,7 +1812,7 @@ I.uncheckOption('agree', '//form');
 
 -   `field` **([string][6] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][6]? | [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 
 
 ### usePuppeteerTo
 
@@ -1852,7 +1845,7 @@ I.wait(2); // wait 2 secs
 #### Parameters
 
 -   `sec` **[number][8]** number of second to wait.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### waitForClickable
 
@@ -1869,7 +1862,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `waitTimeout`  
 -   `sec` **[number][8]?** (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
 
 ### waitForDetached
 
@@ -1884,7 +1877,7 @@ I.waitForDetached('#popup');
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]** (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
 
@@ -1900,8 +1893,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]?** (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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1916,7 +1908,7 @@ Element can be located by CSS or XPath.
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]** (optional) time in seconds to wait, 1 by default.
-    [!] returns a _promise_ which is synchronized internally by recorder 
+    ⚠️ returns a _promise_ which is synchronized internally by recorder 
 
 ### waitForFunction
 
@@ -1938,7 +1930,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 -   `fn` **([string][6] | [function][10])** to be executed in browser context.
 -   `argsOrSec` **([Array][12]&lt;any> | [number][8])?** (optional, `1` by default) arguments for function or seconds. 
 -   `sec` **[number][8]?** (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
 
@@ -1953,7 +1945,7 @@ I.waitForInvisible('#popup');
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]** (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 
 
 ### waitForNavigation
 
@@ -2009,7 +2001,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `text` **[string][6]** to wait for.
 -   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
 -   `context` **([string][6] | [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 
 
 ### waitForValue
 
@@ -2024,7 +2016,7 @@ I.waitForValue('//input', "GoodValue");
 -   `field` **([string][6] | [object][4])** input field.
 -   `value` **[string][6]** expected value.
 -   `sec` **[number][8]** (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 
 
 ### waitForVisible
 
@@ -2039,7 +2031,7 @@ I.waitForVisible('#popup');
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
-    [!] returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][21]. 
+    ⚠️ returns a _promise_ which is synchronized internally by recorderThis method accepts [React selectors][21]. 
 
 ### waitInUrl
 
@@ -2053,7 +2045,7 @@ I.waitInUrl('/info', 2);
 
 -   `urlPart` **[string][6]** value to check.
 -   `sec` **[number][8]** (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
 
@@ -2068,8 +2060,7 @@ I.waitNumberOfVisibleElements('a', 3);
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][8]** number of elements.
 -   `sec` **[number][8]** (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
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -2088,7 +2079,7 @@ I.waitToHide('#popup');
 
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][8]** (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
 
@@ -2103,7 +2094,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 -   `urlPart` **[string][6]** value to check.
 -   `sec` **[number][8]** (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 
 
 : https://github.com/GoogleChrome/puppeteer
 

package/docs/helpers/REST.md

@@ -22,7 +22,7 @@ Type: [object][4]
 
 ### Properties
 
--   `endpoint` **[string][3]** API base URL
+-   `endpoint` **[string][3]?** API base URL
 -   `prettyPrintJson` **[boolean][6]?** pretty print json for response/request on console logs
 -   `timeout` **[number][5]?** timeout for requests in milliseconds. 10000ms by default
 -   `defaultHeaders` **[object][4]?** a list of default headers