codeceptjs 2.3.4 → 2.4.1

package/docs/helpers/Puppeteer.md

@@ -1,5 +1,7 @@
 ---
-id: Puppeteer
+permalink: /helpers/Puppeteer
+editLink: false
+sidebar: auto
 title: Puppeteer
 ---
 
@@ -7,7 +9,7 @@ title: Puppeteer
 
 ## Puppeteer
 
-Extends Helper
+**Extends Helper**
 
 Uses [Google Chrome's Puppeteer][1] library to run tests inside headless Chrome.
 Browser control is executed via DevTools Protocol (instead of Selenium).
@@ -22,6 +24,7 @@ Requires `puppeteer` package to be installed.
 This helper should be configured in codecept.json or codecept.conf.js
 
 -   `url`: base url of website to be tested
+-   `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
 -   `show`:  - show Google Chrome window for debug.
 -   `restart`:  - restart browser between tests.
 -   `disableScreenshots`:   - don't save screenshot on failure.
@@ -33,7 +36,7 @@ This helper should be configured in codecept.json or codecept.conf.js
 -   `waitForNavigation`: . When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API][3]. Array values are accepted as well.
 -   `pressKeyDelay`: . Delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
 -   `getPageTimeout`  config option to set maximum navigation time in milliseconds.
--   `waitForTimeout`: (optional) default wait\ timeout in ms. Default: 1000.
+-   `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
 -   `windowSize`: (optional) default window size. Set a dimension like `640x480`.
 -   `userAgent`: (optional) user-agent string.
 -   `manualStart`:  - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
@@ -98,6 +101,20 @@ This helper should be configured in codecept.json or codecept.conf.js
 }
 ```
 
+#### Example #5: Target URL with provided basic authentication
+
+```js
+{
+   helpers: {
+     Puppeteer : {
+       url: 'http://localhost',
+       basicAuth: {username: 'username', password: 'password'},
+       show: true
+     }
+   }
+}
+```
+
 Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
 
 ## Access From Helpers
@@ -118,7 +135,7 @@ await page.url(); // Get the url of the current page
 
 -   `config`  
 
-### \_addPopupListener
+### _addPopupListener
 
 Add the 'dialog' event listener to a page
 
@@ -126,11 +143,11 @@ Add the 'dialog' event listener to a page
 
 -   `page`  
 
-### \_getPageUrl
+### _getPageUrl
 
 Gets page URL including hash.
 
-### \_locate
+### _locate
 
 Get elements by different locator types, including strict locator
 Should be used in custom helpers:
@@ -149,7 +166,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 -   `locator`  
 
-### \_locateCheckable
+### _locateCheckable
 
 Find a checkbox by providing human readable text:
 NOTE: Assumes the checkable element exists
@@ -163,7 +180,7 @@ this.helpers['Puppeteer']._locateCheckable('I agree with terms and conditions').
 -   `locator`  
 -   `providedContext`   
 
-### \_locateClickable
+### _locateClickable
 
 Find a clickable element by providing human readable text:
 
@@ -175,7 +192,7 @@ this.helpers['Puppeteer']._locateClickable('Next page').then // ...
 
 -   `locator`  
 
-### \_locateFields
+### _locateFields
 
 Find field elements by providing human readable text:
 
@@ -187,13 +204,13 @@ this.helpers['Puppeteer']._locateFields('Your email').then // ...
 
 -   `locator`  
 
-### \_setPage
+### _setPage
 
 Set current page
 
 #### Parameters
 
--   `page` [object][6] page to set
+-   `page` **[object][6]** page to set
 
 ### acceptPopup
 
@@ -236,9 +253,7 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url` [string][8] url path or global url.
-    
-
+-   `url` **[string][8]** url path or global url.
 
 ### appendField
 
@@ -251,10 +266,8 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator
--   `value` [string][8] text value to append.
-    
-
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator
+-   `value` **[string][8]** text value to append.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -273,10 +286,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` [string][8] local file path relative to codecept.json config file.
-    
-
+-   `locator` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+-   `pathToFile` **[string][8]** local file path relative to codecept.json config file.
 
 ### cancelPopup
 
@@ -297,10 +308,8 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][8] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
- 
+-   `field` **([string][8] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 
 ### clearCookie
 
@@ -315,9 +324,7 @@ I.clearCookie('test');
 #### Parameters
 
 -   `name`  
--   `cookie` [string][8] (optional, `null` by default) cookie name
-    
-
+-   `cookie` **[string][8]?** (optional, `null` by default) cookie name 
 
 ### clearField
 
@@ -332,9 +339,7 @@ I.clearField('#email');
 #### Parameters
 
 -   `field`  
--   `editable` ([string][8] \| [object][6]) field located by label|name|CSS|XPath|strict locator.
-    
-
+-   `editable` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
 ### click
 
@@ -353,7 +358,7 @@ I.click('Submit');
 // CSS button
 I.click('#form input[type=submit]');
 // XPath
-I.click('//form/[@type=submit]');
+I.click('//form/*[@type=submit]');
 // link in context
 I.click('Logout', '#nav');
 // using strict locator
@@ -362,10 +367,8 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` ([string][8] \| [object][6]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -381,10 +384,8 @@ I.clickLink('Logout', '#nav');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) clickable link or button located by text, or any element located by CSS|XPath|strict locator
--   `context` ([string][8] \| [object][6]) (optional, `null` by default) element to search in CSS|XPath|Strict locator
-    
-
+-   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -418,9 +419,8 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 #### Parameters
 
--   `text` [string][8] which is not present.
--   `context` ([string][8] \| [object][6]) (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-
+-   `text` **[string][8]** which is not present.
+-   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -438,9 +438,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
-    
-
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
 
 ### dontSeeCookie
 
@@ -452,9 +450,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 
 #### Parameters
 
--   `name` [string][8] cookie name.
-    
-
+-   `name` **[string][8]** cookie name.
 
 ### dontSeeCurrentUrlEquals
 
@@ -468,9 +464,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 
 #### Parameters
 
--   `url` [string][8] value to check.
-    
-
+-   `url` **[string][8]** value to check.
 
 ### dontSeeElement
 
@@ -482,9 +476,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|Strict locator.
     
 
 
@@ -501,9 +493,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|Strict locator.
 
 ### dontSeeInCurrentUrl
 
@@ -511,9 +501,7 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url` [string][8] value to check.
-    
-
+-   `url` **[string][8]** value to check.
 
 ### dontSeeInField
 
@@ -527,10 +515,8 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][8] value to check.
-    
-
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][8]** value to check.
 
 ### dontSeeInSource
 
@@ -543,9 +529,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 #### Parameters
 
 -   `text`  
--   `value` [string][8] to check.
-    
-
+-   `value` **[string][8]** to check.
 
 ### dontSeeInTitle
 
@@ -557,9 +541,7 @@ I.dontSeeInTitle('Error');
 
 #### Parameters
 
--   `text` [string][8] value to check.
-    
-
+-   `text` **[string][8]** value to check.
 
 ### doubleClick
 
@@ -575,10 +557,8 @@ I.doubleClick('.btn.edit');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` ([string][8] \| [object][6]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -586,7 +566,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### downloadFile
 
-This method is deprecated.
+This method is **deprecated**.
 
 Please use `handleDownloads()` instead.
 
@@ -605,10 +585,8 @@ I.dragAndDrop('#dragHandle', '#container');
 
 #### Parameters
 
--   `srcElement` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
--   `destElement` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
-    
-
+-   `srcElement` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
+-   `destElement` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
 ### dragSlider
 
@@ -622,10 +600,8 @@ I.dragSlider('#slider', -70);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
--   `offsetX` [number][9] position to drag.
-    
-
+-   `locator` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `offsetX` **[number][9]** position to drag.
     
 
 
@@ -657,7 +633,10 @@ let val = await I.executeAsyncScript(function(url, done) {
 
 #### Parameters
 
--   `fn` ([string][8] \| [function][11]) function to be executed in browser context.
+-   `fn` **([string][8] | [function][11])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][12]&lt;any>** Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
 
 ### executeScript
 
@@ -687,7 +666,10 @@ let date = await I.executeScript(function(el) {
 
 #### Parameters
 
--   `fn` ([string][8] \| [function][11]) function to be executed in browser context.
+-   `fn` **([string][8] | [function][11])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][12]&lt;any>** If a function returns a Promise It will wait for it resolution.
 
 ### fillField
 
@@ -707,11 +689,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][8] text value to fill.
-    
-
-    
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][8]** text value to fill.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -721,7 +700,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 Retrieves an attribute from an element located by CSS or XPath and returns it to test.
 An array as a result will be returned if there are more than one matched element.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let hint = await I.grabAttributeFrom('#tooltip', 'title');
@@ -729,12 +708,10 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `attr` [string][8] attribute name.
-
-Returns [Promise][12]&lt;[string][8]> attribute value
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][8]** attribute name.
 
+Returns **[Promise][12]&lt;[string][8]>** attribute value
 
 
 
@@ -750,12 +727,13 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
+Returns **[Promise][12]&lt;[Array][13]&lt;any>>** 
+
 ### grabCookie
 
 Gets a cookie object by name.
 If none provided gets all cookies.
-
--   Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let cookie = await I.grabCookie('auth');
@@ -764,16 +742,14 @@ assert(cookie.value, '123456');
 
 #### Parameters
 
--   `name`  cookie name. 
-
-Returns [Promise][12]&lt;[string][8]> attribute value
+-   `name` **[string][8]?** cookie name. 
 
-Returns cookie in JSON format. If name not passed returns all cookies for this domain.
+Returns **[Promise][12]&lt;[string][8]>** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
 
 ### grabCssPropertyFrom
 
 Grab CSS property for given locator
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 ```js
 const value = await I.grabCssPropertyFrom('h3', 'font-weight');
@@ -781,12 +757,10 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `cssProperty` [string][8] CSS property name.
-
-Returns [Promise][12]&lt;[string][8]> CSS value
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `cssProperty` **[string][8]** CSS property name.
 
+Returns **[Promise][12]&lt;[string][8]>** CSS value
 
 
 
@@ -803,9 +777,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns [Promise][12]&lt;[string][8]> current URL
-
-
+Returns **[Promise][12]&lt;[string][8]>** current URL
 
 ### grabDataFromPerformanceTiming
 
@@ -816,7 +788,7 @@ The returned data will contain following things in ms:
 -   domInteractive,
 -   domContentLoadedEventEnd,
 -   loadEventEnd
-    Resumes test execution, so should be used inside an async function with `await` operator.
+    Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 ```js
 await I.amOnPage('https://example.com');
@@ -830,14 +802,11 @@ let data = await I.grabDataFromPerformanceTiming();
 }
 ```
 
-
-
-
 ### grabElementBoundingRect
 
 Grab the width, height, location of given locator.
 Provide `width` or `height`as second param to get your desired prop.
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 Returns an object with `x`, `y`, `width`, `height` keys.
 
@@ -855,18 +824,16 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `prop`  
--   `elementSize` [string][8] x, y, width or height of the given element.
-
-Returns [object][6] Element bounding rectangle
-
+-   `elementSize` **[string][8]** x, y, width or height of the given element.
 
+Returns **[object][6]** Element bounding rectangle
 
 ### grabHTMLFrom
 
 Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async function with `await` operator.
+Resumes test execution, so **should be used inside async function with `await`** operator.
 If more than one element is found - an array of HTMLs returned.
 
 ```js
@@ -875,11 +842,10 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][12]&lt;[string][8]> HTML code for an element
-
+-   `locator`  
+-   `element` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][12]&lt;[string][8]>** HTML code for an element
 
 ### grabNumberOfOpenTabs
 
@@ -889,9 +855,7 @@ Grab number of open tabs.
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns [Promise][12]&lt;[number][9]> number of open tabs
-
-
+Returns **[Promise][12]&lt;[number][9]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -903,11 +867,9 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
-
-Returns [Promise][12]&lt;[number][9]> number of visible elements
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][12]&lt;[number][9]>** number of visible elements
 
 
 
@@ -917,15 +879,13 @@ This action supports [React locators](https://codecept.io/react#locators)
 ### grabPageScrollPosition
 
 Retrieves a page scroll position and returns it to test.
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 ```js
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns [Promise][12]&lt;[object][6]> scroll position
-
-
+Returns **[Promise][12]&lt;[Object][6]&lt;[string][8], any>>** scroll position
 
 ### grabPopupText
 
@@ -935,6 +895,8 @@ Grab the text within the popup. If no popup is visible then it will return null
 await I.grabPopupText();
 ```
 
+Returns **[Promise][12]&lt;([string][8] | null)>** 
+
 ### grabSource
 
 Retrieves page source and returns it to test.
@@ -944,14 +906,12 @@ Resumes test execution, so should be used inside an async function.
 let pageSource = await I.grabSource();
 ```
 
-Returns [Promise][12]&lt;[string][8]> source code
-
-
+Returns **[Promise][12]&lt;[string][8]>** source code
 
 ### grabTextFrom
 
 Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let pin = await I.grabTextFrom('#pin');
@@ -961,11 +921,9 @@ If multiple elements found returns an array of texts.
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][12]&lt;[string][8]> attribute value
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 
+Returns **[Promise][12]&lt;([string][8] | [Array][13]&lt;[string][8]>)>** attribute value
 
 
 
@@ -975,20 +933,18 @@ This action supports [React locators](https://codecept.io/react#locators)
 ### grabTitle
 
 Retrieves a page title and returns it to test.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let title = await I.grabTitle();
 ```
 
-Returns [Promise][12]&lt;[string][8]> title
-
-
+Returns **[Promise][12]&lt;[string][8]>** title
 
 ### grabValueFrom
 
 Retrieves a value from a form element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async function with `await` operator.
+Resumes test execution, so **should be used inside async function with `await`** operator.
 
 ```js
 let email = await I.grabValueFrom('input[name=email]');
@@ -996,16 +952,14 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) field located by label|name|CSS|XPath|strict locator.
-
-Returns [Promise][12]&lt;[string][8]> attribute value
-
+-   `locator` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][12]&lt;[string][8]>** attribute value
 
 ### handleDownloads
 
 Sets a directory to where save files. Allows to test file downloads.
-Should be used with [FileSystem helper][13] to check that file were downloaded correctly.
+Should be used with [FileSystem helper][14] to check that file were downloaded correctly.
 
 By default files are saved to `output/downloads`.
 This directory is cleaned on every `handleDownloads` call, to ensure no old files are kept.
@@ -1019,7 +973,7 @@ I.seeFile('avatar.jpg');
 
 #### Parameters
 
--   `downloadPath` [string][8] change this parameter to set another directory for saving 
+-   `downloadPath` **[string][8]** change this parameter to set another directory for saving 
 
 ### haveRequestHeaders
 
@@ -1033,7 +987,7 @@ I.haveRequestHeaders({
 
 #### Parameters
 
--   `customHeaders` [object][6] headers to set
+-   `customHeaders` **[object][6]** headers to set
 
 ### moveCursorTo
 
@@ -1047,12 +1001,9 @@ I.moveCursorTo('#submit', 5,5);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) 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.
-    
-
-    
+-   `locator` **([string][8] | [object][6])** 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.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1070,7 +1021,7 @@ I.openNewTab();
 
 Presses a key in the browser (on a focused element).
 
-_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][14].
+_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][15].
 
 ```js
 I.pressKey('Backspace');
@@ -1129,9 +1080,7 @@ Some of the supported key names are:
 
 #### Parameters
 
--   `key` ([string][8] \| [array][15]) key or array of keys to press.
-    
-_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][16]).
+-   `key` **([string][8] | [Array][13]&lt;[string][8]>)** key or array of keys to press._Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][16]).
 
 ### pressKeyDown
 
@@ -1147,9 +1096,7 @@ I.pressKeyUp('Control');
 
 #### Parameters
 
--   `key` [string][8] name of key to press down.
-    
-
+-   `key` **[string][8]** name of key to press down.
 
 ### pressKeyUp
 
@@ -1165,9 +1112,7 @@ I.pressKeyUp('Control');
 
 #### Parameters
 
--   `key` [string][8] name of key to release.
-    
-
+-   `key` **[string][8]** name of key to release.
 
 ### refreshPage
 
@@ -1177,9 +1122,6 @@ Reload the current page.
 I.refreshPage();
 ```
 
-
-
-
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -1187,10 +1129,8 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` [number][9] width in pixels or `maximize`.
--   `height` [number][9] height in pixels.
-    
-Unlike other drivers Puppeteer changes the size of a viewport, not the window!
+-   `width` **[number][9]** width in pixels or `maximize`.
+-   `height` **[number][9]** height in pixels.Unlike 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.
 
@@ -1209,10 +1149,8 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) clickable element located by CSS|XPath|strict locator.
--   `context` ([string][8] \| [object][6]) (optional, `null` by default) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** clickable element located by CSS|XPath|strict locator.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1231,10 +1169,8 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 #### Parameters
 
--   `fileName` [string][8] file name to save.
--   `fullPage` [boolean][18] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-    
-
+-   `fileName` **[string][8]** file name to save.
+-   `fullPage` **[boolean][18]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
 
 ### scrollPageToBottom
 
@@ -1244,9 +1180,6 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-
-
-
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -1255,9 +1188,6 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-
-
-
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -1270,11 +1200,9 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) 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.
-    
- 
+-   `locator` **([string][8] | [object][6])** 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. 
 
 ### see
 
@@ -1289,10 +1217,8 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 #### Parameters
 
--   `text` [string][8] expected on page.
--   `context` ([string][8] \| [object][6]) (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-    
-
+-   `text` **[string][8]** expected on page.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1308,10 +1234,8 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
--   `attributes` [object][6] attributes and their values to check.
-    
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
+-   `attributes` **[object][6]** attributes and their values to check.
     
 
 
@@ -1330,9 +1254,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
-    
-
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
 
 ### seeCookie
 
@@ -1344,9 +1266,7 @@ I.seeCookie('Auth');
 
 #### Parameters
 
--   `name` [string][8] cookie name.
-    
-
+-   `name` **[string][8]** cookie name.
 
 ### seeCssPropertiesOnElements
 
@@ -1358,10 +1278,8 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
--   `cssProperties` [object][6] object with CSS properties and their values to check.
-    
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
+-   `cssProperties` **[object][6]** object with CSS properties and their values to check.
     
 
 
@@ -1381,9 +1299,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url` [string][8] value to check.
-    
-
+-   `url` **[string][8]** value to check.
 
 ### seeElement
 
@@ -1396,9 +1312,7 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** located by CSS|XPath|strict locator.
     
 
 
@@ -1416,9 +1330,7 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 
 ### seeInCurrentUrl
 
@@ -1430,9 +1342,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url` [string][8] a fragment to check
-    
-
+-   `url` **[string][8]** a fragment to check
 
 ### seeInField
 
@@ -1448,10 +1358,8 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][8] value to check.
-    
-
+-   `field` **([string][8] | [object][6])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][8]** value to check.
 
 ### seeInPopup
 
@@ -1472,9 +1380,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text` [string][8] value to check.
-    
-
+-   `text` **[string][8]** value to check.
 
 ### seeInTitle
 
@@ -1486,9 +1392,7 @@ I.seeInTitle('Home Page');
 
 #### Parameters
 
--   `text` [string][8] text value to check.
-    
-
+-   `text` **[string][8]** text value to check.
 
 ### seeNumberOfElements
 
@@ -1501,10 +1405,8 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `num` [number][9] number of elements.
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `num` **[number][9]** number of elements.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1521,10 +1423,8 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `num` [number][9] number of elements.
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `num` **[number][9]** number of elements.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1540,8 +1440,8 @@ I.seeTextEquals('text', 'h1');
 
 #### Parameters
 
--   `text`  
--   `context`   
+-   `text` **[string][8]** element value to check.
+-   `context` **([string][8] | [object][6]?)** element located by CSS|XPath|strict locator. 
 
 ### seeTitleEquals
 
@@ -1578,10 +1478,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select` ([string][8] \| [object][6]) field located by label|name|CSS|XPath|strict locator.
--   `option` ([string][8] \| [array][15]) visible text or value of option.
-    
-
+-   `select` **([string][8] | [object][6])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][8] | [Array][13]&lt;any>)** visible text or value of option.
 
 ### setCookie
 
@@ -1593,9 +1491,7 @@ I.setCookie({name: 'auth', value: true});
 
 #### Parameters
 
--   `cookie` [object][6] a cookie object.
-    
-
+-   `cookie` **[object][6]** a cookie object.
 
 ### switchTo
 
@@ -1608,9 +1504,7 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) (optional, `null` by default) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
 
 ### switchToNextTab
 
@@ -1623,7 +1517,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num` [number][9]  
+-   `num` **[number][9]**  
 
 ### switchToPreviousTab
 
@@ -1636,7 +1530,7 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num` [number][9]  
+-   `num` **[number][9]**  
 
 ### uncheckOption
 
@@ -1653,10 +1547,8 @@ I.uncheckOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][8] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
- 
+-   `field` **([string][8] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][8]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 
 ### wait
 
@@ -1668,9 +1560,23 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` [number][9] number of second to wait.
-    
+-   `sec` **[number][9]** number of second to wait.
 
+### waitForClickable
+
+Waits for element to be clickable (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForClickable('.btn.continue');
+I.waitForClickable('.btn.continue', 5); // wait for 5 secs
+```
+
+#### Parameters
+
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `waitTimeout`  
+-   `sec` **[number][9]?** (optional, `1` by default) time in seconds to wait
 
 ### waitForDetached
 
@@ -1683,10 +1589,8 @@ I.waitForDetached('#popup');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForElement
 
@@ -1700,10 +1604,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]?** (optional, `1` by default) time in seconds to wait
     
 
 
@@ -1717,10 +1619,8 @@ Element can be located by CSS or XPath.
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]** (optional) time in seconds to wait, 1 by default. 
 
 ### waitForFunction
 
@@ -1739,11 +1639,9 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` ([string][8] \| [function][11]) to be executed in browser context.
--   `argsOrSec` ([array][15] \| [number][9]) (optional, `1` by default) arguments for function or seconds. 
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `fn` **([string][8] | [function][11])** to be executed in browser context.
+-   `argsOrSec` **([Array][13]&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 
 
 ### waitForInvisible
 
@@ -1756,10 +1654,8 @@ I.waitForInvisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForNavigation
 
@@ -1769,7 +1665,7 @@ See [Pupeteer's reference][3]
 
 #### Parameters
 
--   `opts` any  
+-   `opts` **any**  
 
 ### waitForRequest
 
@@ -1782,8 +1678,8 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 #### Parameters
 
--   `urlOrPredicate` ([string][8] \| [function][11]) 
--   `sec` [number][9]? seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][11])** 
+-   `sec` **[number][9]?** seconds to wait 
 
 ### waitForResponse
 
@@ -1796,8 +1692,8 @@ I.waitForResponse(request => request.url() === 'http://example.com' && request.m
 
 #### Parameters
 
--   `urlOrPredicate` ([string][8] \| [function][11]) 
--   `sec` [number][9]? number of seconds to wait 
+-   `urlOrPredicate` **([string][8] | [function][11])** 
+-   `sec` **[number][9]?** number of seconds to wait 
 
 ### waitForText
 
@@ -1812,11 +1708,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 #### Parameters
 
--   `text` [string][8] to wait for.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait 
--   `context` ([string][8] \| [object][6]) (optional) element located by CSS|XPath|strict locator.
-    
- 
+-   `text` **[string][8]** to wait for.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][8] | [object][6])?** (optional) element located by CSS|XPath|strict locator. 
 
 ### waitForValue
 
@@ -1828,11 +1722,9 @@ I.waitForValue('//input', "GoodValue");
 
 #### Parameters
 
--   `field` ([string][8] \| [object][6]) input field.
--   `value` [string][8] expected value.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `field` **([string][8] | [object][6])** input field.
+-   `value` **[string][8]** expected value.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForVisible
 
@@ -1845,10 +1737,8 @@ I.waitForVisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-This method accepts [React selectors][19].
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to waitThis method accepts [React selectors][19]. 
 
 ### waitInUrl
 
@@ -1860,10 +1750,8 @@ I.waitInUrl('/info', 2);
 
 #### Parameters
 
--   `urlPart` [string][8] value to check.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `urlPart` **[string][8]** value to check.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 ### waitNumberOfVisibleElements
 
@@ -1875,16 +1763,14 @@ I.waitNumberOfVisibleElements('a', 3);
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) 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
-    
-
+-   `locator` **([string][8] | [object][6])** 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
     
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### waitToHide
 
@@ -1897,10 +1783,8 @@ I.waitToHide('#popup');
 
 #### Parameters
 
--   `locator` ([string][8] \| [object][6]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 ### waitUntil
 
@@ -1913,11 +1797,10 @@ I.waitUntil(() => window.requests == 0, 5);
 
 #### Parameters
 
--   `fn` ([function][11] \| [string][8]) function which is executed in browser context.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait 
--   `timeoutMsg` [string][8] message to show in case of timeout fail.
-    
- 
+-   `fn` **([function][11] | [string][8])** function which is executed in browser context.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
+-   `timeoutMsg` **[string][8]** message to show in case of timeout fail. 
+-   `interval` **[number][9]?**  
 
 ### waitUrlEquals
 
@@ -1930,10 +1813,8 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 #### Parameters
 
--   `urlPart` [string][8] value to check.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `urlPart` **[string][8]** value to check.
+-   `sec` **[number][9]** (optional, `1` by default) time in seconds to wait 
 
 [1]: https://github.com/GoogleChrome/puppeteer
 
@@ -1959,11 +1840,11 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[13]: https://codecept.io/helpers/FileSystem
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[14]: #fillfield
+[14]: https://codecept.io/helpers/FileSystem
 
-[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[15]: #fillfield
 
 [16]: https://github.com/GoogleChrome/puppeteer/issues/1313