codeceptjs 2.1.3 → 2.2.1

package/docs/helpers/REST.md

@@ -2,11 +2,12 @@
 id: REST
 title: REST
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## REST
 
-**Extends Helper**
+Extends Helper
 
 REST helper allows to send additional requests to the REST API during acceptance tests.
 [Axios][1] library is used to perform requests.
@@ -52,7 +53,7 @@ Executes axios request
 
 #### Parameters
 
--   `request` **any** 
+-   `request` any 
 
 ### \_url
 
@@ -60,7 +61,7 @@ Generates url based on format sent (takes endpoint + url if latter lacks 'http')
 
 #### Parameters
 
--   `url` **any** 
+-   `url` any 
 
 ### sendDeleteRequest
 
@@ -72,8 +73,8 @@ I.sendDeleteRequest('/api/users/1');
 
 #### Parameters
 
--   `url` **any** 
--   `headers` **[object][2]**  (optional, default `{}`)
+-   `url` any 
+-   `headers` [object][2]  
 
 ### sendGetRequest
 
@@ -85,8 +86,8 @@ I.sendGetRequest('/api/users.json');
 
 #### Parameters
 
--   `url` **any** 
--   `headers` **[object][2]**  (optional, default `{}`)
+-   `url` any 
+-   `headers` [object][2]  
 
 ### sendPatchRequest
 
@@ -98,9 +99,9 @@ I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` **[string][3]** 
--   `payload` **[object][2]** 
--   `headers` **[object][2]**  (optional, default `{}`)
+-   `url` [string][3] 
+-   `payload` [object][2] 
+-   `headers` [object][2]  
 
 ### sendPostRequest
 
@@ -112,9 +113,9 @@ I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` **any** 
--   `payload` **any**  (optional, default `{}`)
--   `headers` **[object][2]**  (optional, default `{}`)
+-   `url` any 
+-   `payload` any  
+-   `headers` [object][2]  
 
 ### sendPutRequest
 
@@ -126,9 +127,9 @@ I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` **[string][3]** 
--   `payload` **[object][2]**  (optional, default `{}`)
--   `headers` **[object][2]**  (optional, default `{}`)
+-   `url` [string][3] 
+-   `payload` [object][2]  
+-   `headers` [object][2]  
 
 ### setRequestTimeout
 

package/docs/helpers/SeleniumWebdriver.md

@@ -2,11 +2,12 @@
 id: SeleniumWebdriver
 title: SeleniumWebdriver
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## SeleniumWebdriver
 
-**Extends Helper**
+Extends Helper
 
 SeleniumWebdriver helper is based on the official [Selenium Webdriver JS][1]
 library. It implements common web api methods (amOnPage, click, see).
@@ -35,16 +36,16 @@ This helper should be configured in codecept.json or codecept.conf.js
 -   `browser` - browser in which perform testing
 -   `driver` - which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started.
 -   `restart` - restart browser between tests (default: true).
--   `smartWait`: (optional) **enables SmartWait**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000
--   `disableScreenshots` (optional, default: false)  - don't save screenshot on failure
--   `uniqueScreenshotNames` (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites
--   `keepBrowserState` (optional, default: false)  - keep browser state between tests when `restart` set to false.
--   `keepCookies` (optional, default: false)  - keep cookies between tests when `restart` set to false.\*
+-   `smartWait`: (optional) enables SmartWait; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000
+-   `disableScreenshots`   - don't save screenshot on failure
+-   `uniqueScreenshotNames`   - option to prevent screenshot override if you have scenarios with the same name in different suites
+-   `keepBrowserState`   - keep browser state between tests when `restart` set to false.
+-   `keepCookies`   - keep cookies between tests when `restart` set to false.\
 -   `seleniumAddress` - Selenium address to connect (default: [http://localhost:4444/wd/hub][7])
--   `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait*` functions. 1000 by default;
+-   `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait` functions. 1000 by default;
 -   `scriptTimeout`: (optional) sets default timeout for scripts in `executeAsync`. 1000 by default.
 -   `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
--   `manualStart` (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
+-   `manualStart`  - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
 -   `capabilities`: {} - list of [Desired Capabilities][8]
 
 Example: