codeceptjs 2.3.4 → 2.4.1

package/docs/helpers/Nightmare.md

@@ -1,5 +1,7 @@
 ---
-id: Nightmare
+permalink: /helpers/Nightmare
+editLink: false
+sidebar: auto
 title: Nightmare
 ---
 
@@ -7,7 +9,7 @@ title: Nightmare
 
 ## Nightmare
 
-Extends Helper
+**Extends Helper**
 
 Nightmare helper wraps [Nightmare][1] library to provide
 fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses
@@ -28,7 +30,7 @@ This helper should be configured in codecept.json or codecept.conf.js
 -   `keepBrowserState`   - keep browser state between tests when `restart` set to false.
 -   `keepCookies`   - keep cookies between tests when `restart` set to false.
 -   `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 500.
--   `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`.
 
 
@@ -40,7 +42,7 @@ This helper should be configured in codecept.json or codecept.conf.js
 
 -   `config`  
 
-### \_locate
+### _locate
 
 Locate elements by different locator types, including strict locator.
 Should be used in custom helpers.
@@ -77,10 +79,8 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url` [string][3] url path or global url.
-    
-
--   `headers`  {object} list of request headers can be passed
+-   `url` **[string][3]** url path or global url.
+-   `headers` **[object][4]?** list of request headers can be passed 
 
 ### appendField
 
@@ -93,10 +93,8 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator
--   `value` [string][3] text value to append.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator
+-   `value` **[string][3]** text value to append.
 
 ### attachFile
 
@@ -111,10 +109,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 #### Parameters
 
--   `locator`  CSS locator (XPath not allowed)
--   `pathToFile` [string][3] local file path relative to codecept.json config file.
-    
-Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][5])
+-   `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.Doesn'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
 
@@ -131,10 +127,8 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][3] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
- 
+-   `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. 
 
 ### clearCookie
 
@@ -148,9 +142,7 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie` [string][3] (optional, `null` by default) cookie name
-    
-
+-   `cookie` **[string][3]?** (optional, `null` by default) cookie name 
 
 ### clearField
 
@@ -165,9 +157,7 @@ I.clearField('#email');
 #### Parameters
 
 -   `field`  
--   `editable` ([string][3] \| [object][4]) field located by label|name|CSS|XPath|strict locator.
-    
-
+-   `editable` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 
 ### click
 
@@ -186,7 +176,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
@@ -195,10 +185,8 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `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.
-    
- 
+-   `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. 
 
 ### dontSee
 
@@ -212,9 +200,8 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 #### Parameters
 
--   `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.
- 
+-   `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. 
 
 ### dontSeeCheckboxIsChecked
 
@@ -228,9 +215,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 
 ### dontSeeCookie
 
@@ -242,9 +227,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 
 #### Parameters
 
--   `name` [string][3] cookie name.
-    
-
+-   `name` **[string][3]** cookie name.
 
 ### dontSeeCurrentUrlEquals
 
@@ -258,9 +241,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 
 #### Parameters
 
--   `url` [string][3] value to check.
-    
-
+-   `url` **[string][3]** value to check.
 
 ### dontSeeElement
 
@@ -272,9 +253,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) located by CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
 
 ### dontSeeElementInDOM
 
@@ -286,9 +265,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.
-    
-
+-   `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
 
 ### dontSeeInCurrentUrl
 
@@ -296,9 +273,7 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url` [string][3] value to check.
-    
-
+-   `url` **[string][3]** value to check.
 
 ### dontSeeInField
 
@@ -312,10 +287,8 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][3] value to check.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][3]** value to check.
 
 ### dontSeeInSource
 
@@ -328,9 +301,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 #### Parameters
 
 -   `text`  
--   `value` [string][3] to check.
-    
-
+-   `value` **[string][3]** to check.
 
 ### dontSeeInTitle
 
@@ -342,9 +313,7 @@ I.dontSeeInTitle('Error');
 
 #### Parameters
 
--   `text` [string][3] value to check.
-    
-
+-   `text` **[string][3]** value to check.
 
 ### doubleClick
 
@@ -360,10 +329,8 @@ I.doubleClick('.btn.edit');
 
 #### Parameters
 
--   `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.
-    
- 
+-   `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. 
 
 ### executeAsyncScript
 
@@ -390,7 +357,11 @@ let val = await I.executeAsyncScript(function(url, done) {
 
 #### Parameters
 
--   `fn` ([string][3] \| [function][7]) function to be executed in browser context.
+-   `fn` **([string][3] | [function][7])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][8]&lt;any>** Wrapper for asynchronous [evaluate][9].
+Unlike NightmareJS implementation calling `done` will return its first argument.
 
 ### executeScript
 
@@ -420,7 +391,10 @@ let date = await I.executeScript(function(el) {
 
 #### Parameters
 
--   `fn` ([string][3] \| [function][7]) function to be executed in browser context.
+-   `fn` **([string][3] | [function][7])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][8]&lt;any>** Wrapper for synchronous [evaluate][9]
 
 ### fillField
 
@@ -440,16 +414,14 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][3] text value to fill.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][3]** text value to fill.
 
 ### grabAttributeFrom
 
 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');
@@ -457,19 +429,16 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `attr` [string][3] attribute name.
-
-Returns [Promise][8]&lt;[string][3]> attribute value
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][3]** attribute name.
 
+Returns **[Promise][8]&lt;[string][3]>** attribute value
 
 ### 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');
@@ -478,13 +447,9 @@ assert(cookie.value, '123456');
 
 #### Parameters
 
--   `name`  cookie name. 
-
-Returns [Promise][8]&lt;[string][3]> attribute value
-
+-   `name` **[string][3]?** cookie name. 
 
-
-Returns any Promise<object> Cookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
+Returns **[Promise][8]&lt;[string][3]>** attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
 
 ### grabCurrentUrl
 
@@ -496,9 +461,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns [Promise][8]&lt;[string][3]> current URL
-
-
+Returns **[Promise][8]&lt;[string][3]>** current URL
 
 ### grabHAR
 
@@ -512,7 +475,7 @@ fs.writeFileSync('sample.har', JSON.stringify({log: har}));
 ### 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
@@ -521,11 +484,10 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][8]&lt;[string][3]> HTML code for an element
-
+-   `locator`  
+-   `element` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][8]&lt;[string][3]>** HTML code for an element
 
 ### grabNumberOfVisibleElements
 
@@ -537,29 +499,25 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) located by CSS|XPath|strict locator.
-
-Returns [Promise][8]&lt;[number][9]> number of visible elements
-
+-   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][8]&lt;[number][10]>** number of visible elements
 
 ### 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][8]&lt;[object][4]> scroll position
-
-
+Returns **[Promise][8]&lt;[Object][4]&lt;[string][3], any>>** scroll position
 
 ### 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');
@@ -569,29 +527,25 @@ If multiple elements found returns an array of texts.
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][8]&lt;[string][3]> attribute value
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 
+Returns **[Promise][8]&lt;([string][3] | [Array][11]&lt;[string][3]>)>** attribute value
 
 ### 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][8]&lt;[string][3]> title
-
-
+Returns **[Promise][8]&lt;[string][3]>** 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]');
@@ -599,11 +553,9 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) field located by label|name|CSS|XPath|strict locator.
-
-Returns [Promise][8]&lt;[string][3]> attribute value
-
+-   `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][8]&lt;[string][3]>** attribute value
 
 ### haveHeader
 
@@ -631,15 +583,13 @@ I.moveCursorTo('#submit', 5,5);
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) 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][3] | [object][4])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset. 
 
 ### pressKey
 
-Sends [input event][10] on a page.
+Sends [input event][12] on a page.
 Can submit special keys like 'Enter', 'Backspace', etc
 
 #### Parameters
@@ -658,9 +608,6 @@ Reload the current page.
 I.refreshPage();
 ```
 
-
-
-
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -668,10 +615,8 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` [number][9] width in pixels or `maximize`.
--   `height` [number][9] height in pixels.
-    
-
+-   `width` **[number][10]** width in pixels or `maximize`.
+-   `height` **[number][10]** height in pixels.
 
 ### rightClick
 
@@ -688,10 +633,8 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `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.
-    
- 
+-   `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. 
 
 ### saveScreenshot
 
@@ -706,10 +649,8 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 #### Parameters
 
--   `fileName` [string][3] file name to save.
--   `fullPage` [boolean][11] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-    
- 
+-   `fileName` **[string][3]** file name to save.
+-   `fullPage` **[boolean][13]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
 
 ### scrollPageToBottom
 
@@ -719,9 +660,6 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
-
-
-
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -730,9 +668,6 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-
-
-
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -745,11 +680,9 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) 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][3] | [object][4])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset. 
 
 ### see
 
@@ -764,10 +697,8 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 #### Parameters
 
--   `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.
-    
- 
+-   `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. 
 
 ### seeCheckboxIsChecked
 
@@ -781,9 +712,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 
 ### seeCookie
 
@@ -795,9 +724,7 @@ I.seeCookie('Auth');
 
 #### Parameters
 
--   `name` [string][3] cookie name.
-    
-
+-   `name` **[string][3]** cookie name.
 
 ### seeCurrentUrlEquals
 
@@ -812,9 +739,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url` [string][3] value to check.
-    
-
+-   `url` **[string][3]** value to check.
 
 ### seeElement
 
@@ -827,9 +752,7 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
 ### seeElementInDOM
 
@@ -842,9 +765,7 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 
 ### seeInCurrentUrl
 
@@ -856,9 +777,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url` [string][3] a fragment to check
-    
-
+-   `url` **[string][3]** a fragment to check
 
 ### seeInField
 
@@ -874,10 +793,8 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][3] value to check.
-    
-
+-   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][3]** value to check.
 
 ### seeInSource
 
@@ -889,9 +806,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text` [string][3] value to check.
-    
-
+-   `text` **[string][3]** value to check.
 
 ### seeInTitle
 
@@ -903,9 +818,7 @@ I.seeInTitle('Home Page');
 
 #### Parameters
 
--   `text` [string][3] text value to check.
-    
-
+-   `text` **[string][3]** text value to check.
 
 ### seeNumberOfElements
 
@@ -918,10 +831,8 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `num` [number][9] number of elements.
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `num` **[number][10]** number of elements.
 
 ### seeNumberOfVisibleElements
 
@@ -934,10 +845,8 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `num` [number][9] number of elements.
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `num` **[number][10]** number of elements.
 
 ### selectOption
 
@@ -962,10 +871,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select` ([string][3] \| [object][4]) field located by label|name|CSS|XPath|strict locator.
--   `option` ([string][3] \| [array][12]) visible text or value of option.
-    
-
+-   `select` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][3] | [Array][11]&lt;any>)** visible text or value of option.
 
 ### setCookie
 
@@ -977,14 +884,12 @@ I.setCookie({name: 'auth', value: true});
 
 #### Parameters
 
--   `cookie` [object][4] a cookie object.
-    
-Wrapper for `.cookies.set(cookie)`.
-    [See more][13]
+-   `cookie` **[object][4]** a cookie object.Wrapper for `.cookies.set(cookie)`.
+    [See more][14]
 
 ### triggerMouseEvent
 
-Sends [input event][14] on a page.
+Sends [input event][15] on a page.
 Should be a mouse event like:
  {
 type: 'mouseDown',
@@ -1012,10 +917,8 @@ I.uncheckOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][3] \| [object][4]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][3] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
- 
+-   `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. 
 
 ### wait
 
@@ -1027,9 +930,7 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` [number][9] number of second to wait.
-    
-
+-   `sec` **[number][10]** number of second to wait.
 
 ### waitForDetached
 
@@ -1042,10 +943,8 @@ I.waitForDetached('#popup');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForElement
 
@@ -1059,10 +958,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
 
 ### waitForFunction
 
@@ -1081,11 +978,9 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` ([string][3] \| [function][7]) to be executed in browser context.
--   `argsOrSec` ([array][12] \| [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][3] | [function][7])** to be executed in browser context.
+-   `argsOrSec` **([Array][11]&lt;any> | [number][10])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait 
 
 ### waitForInvisible
 
@@ -1098,10 +993,8 @@ I.waitForInvisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForText
 
@@ -1116,11 +1009,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 #### Parameters
 
--   `text` [string][3] to wait for.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
--   `context` ([string][3] \| [object][4]) (optional) element located by CSS|XPath|strict locator.
-    
- 
+-   `text` **[string][3]** to wait for.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator. 
 
 ### waitForVisible
 
@@ -1133,10 +1024,8 @@ I.waitForVisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
-
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
 ### waitToHide
 
@@ -1149,10 +1038,8 @@ I.waitToHide('#popup');
 
 #### Parameters
 
--   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
--   `sec` [number][9] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
 [1]: https://github.com/segmentio/nightmare
 
@@ -1170,14 +1057,16 @@ I.waitToHide('#popup');
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[9]: https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2
+
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[10]: http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[12]: http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent
 
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[13]: https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie
+[14]: https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie
 
-[14]: http://electron.atom.io/docs/api/web-contents/#contentssendinputeventevent
+[15]: http://electron.atom.io/docs/api/web-contents/#contentssendinputeventevent