codeceptjs 2.1.3 → 2.2.1

package/docs/helpers/Nightmare.md

@@ -2,11 +2,12 @@
 id: Nightmare
 title: Nightmare
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## 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
@@ -20,14 +21,14 @@ Requires `nightmare` package to be installed.
 This helper should be configured in codecept.json or codecept.conf.js
 
 -   `url` - base url of website to be tested
--   `restart` (optional, default: true) - restart browser between tests.
--   `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.
--   `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
--   `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.
+-   `restart`  - restart browser between tests.
+-   `disableScreenshots`   - don't save screenshot on failure.
+-   `uniqueScreenshotNames`   - option to prevent screenshot override if you have scenarios with the same name in different suites.
+-   `fullPageScreenshots`  - make full page screenshots on failure.
+-   `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`.
 
 
@@ -76,10 +77,10 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url`  url path or global url.In a second argument a list of request headers can be passed:```js
-    I.amOnPage('/auth', { 'x-my-custom-header': 'some value' })
-    ```
--   `headers`   (optional, default `null`)
+-   `url` [string][3] url path or global url.
+    
+
+-   `headers`  {object} list of request headers can be passed
 
 ### appendField
 
@@ -92,8 +93,10 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator
--   `value`  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
 
@@ -108,9 +111,10 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 #### Parameters
 
--   `locator`  field located by label|name|CSS|XPath|strict locator.
--   `pathToFile`  local file path relative to codecept.json config file.##### Limitations:-   works only with CSS selectors.
-    -   doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][3])
+-   `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])
 
 ### checkOption
 
@@ -127,8 +131,10 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field`  checkbox located by label | name | CSS | XPath | strict locator.
--   `context`  (optional) element located by CSS | XPath | strict locator.
+-   `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.
+    
+ 
 
 ### clearCookie
 
@@ -142,7 +148,9 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie`  (optional) cookie name.
+-   `cookie` [string][3] (optional, `null` by default) cookie name
+    
+
 
 ### clearField
 
@@ -156,7 +164,10 @@ I.clearField('#email');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field`  
+-   `editable` ([string][3] \| [object][4]) field located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### click
 
@@ -175,7 +186,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
@@ -184,8 +195,10 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `locator`  clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context`  (optional) 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
 
@@ -193,54 +206,89 @@ Opposite to `see`. Checks that a text is not present on a page.
 Use context parameter to narrow down the search.
 
 ```js
-I.dontSee('Login'); // assume we are already logged in
+I.dontSee('Login'); // assume we are already logged in.
+I.dontSee('Login', '.nav'); // no login inside .nav element
 ```
 
 #### Parameters
 
--   `text`  is not present.
--   `context`  (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
 
 Verifies that the specified checkbox is not checked.
 
+```js
+I.dontSeeeCheckboxIsChedcked('#agree'); // located by ID
+I.dontSeeeCheckboxIsChedcked('I agree to terms'); // located by label
+I.dontSeeeCheckboxIsChedcked('agree'); // located by name
+```
+
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### dontSeeCookie
 
 Checks that cookie with given name does not exist.
 
+```js
+I.dontSeeCookie('auth'); // no auth cookie
+```
+
 #### Parameters
 
--   `name`  cookie name.
+-   `name` [string][3] cookie name.
+    
+
 
 ### dontSeeCurrentUrlEquals
 
 Checks that current url is not equal to provided one.
 If a relative url provided, a configured url will be prepended to it.
 
+```js
+I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
+I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
+```
+
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][3] value to check.
+    
+
 
 ### dontSeeElement
 
 Opposite to `seeElement`. Checks that element is not visible (or in DOM)
 
+```js
+I.dontSeeElement('.modal'); // modal is not shown
+```
+
 #### Parameters
 
--   `locator`  located by CSS|XPath|Strict locator.
+-   `locator` ([string][3] \| [object][4]) located by CSS|XPath|Strict locator.
+    
+
 
 ### dontSeeElementInDOM
 
 Opposite to `seeElementInDOM`. Checks that element is not on page.
 
+```js
+I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
+```
+
 #### Parameters
 
--   `locator`  located by CSS|XPath|Strict locator.
+-   `locator` ([string][3] \| [object][4]) located by CSS|XPath|Strict locator.
+    
+
 
 ### dontSeeInCurrentUrl
 
@@ -248,33 +296,55 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][3] value to check.
+    
+
 
 ### dontSeeInField
 
 Checks that value of input field or textare doesn't equal to given value
 Opposite to `seeInField`.
 
+```js
+I.dontSeeInField('email', 'user@user.com'); // field by name
+I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
+```
+
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  value to check.
+-   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][3] value to check.
+    
+
 
 ### dontSeeInSource
 
 Checks that the current page does not contains the given string in its raw source code.
 
+```js
+I.dontSeeInSource('<!--'); // no comments in source
+```
+
 #### Parameters
 
--   `text`  value to check.
+-   `text`  
+-   `value` [string][3] to check.
+    
+
 
 ### dontSeeInTitle
 
 Checks that title does not contain text.
 
+```js
+I.dontSeeInTitle('Error');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][3] value to check.
+    
+
 
 ### doubleClick
 
@@ -290,19 +360,21 @@ I.doubleClick('.btn.edit');
 
 #### Parameters
 
--   `locator`  clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context`  (optional) 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
 
 Executes async script on page.
 Provided function should execute a passed callback (as first argument) to signal it is finished.
 
-Example: In Vue.js to make components completely rendered we are waiting for [nextTick][4].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][6].
 
 ```js
 I.executeAsyncScript(function(done) {
-Vue.nextTick(done); // waiting for next tick
+  Vue.nextTick(done); // waiting for next tick
 });
 ```
 
@@ -311,14 +383,14 @@ Additional arguments can be passed as well, while `done` function is always last
 
 ```js
 let val = await I.executeAsyncScript(function(url, done) {
-// in browser context
-$.ajax(url, { success: (data) => done(data); }
+  // in browser context
+  $.ajax(url, { success: (data) => done(data); }
 }, 'http://ajax.callback.url/');
 ```
 
 #### Parameters
 
--   `fn`  function to be executed in browser context.
+-   `fn` ([string][3] \| [function][7]) function to be executed in browser context.
 
 ### executeScript
 
@@ -332,8 +404,8 @@ Example with jQuery DatePicker:
 ```js
 // change date of jQuery DatePicker
 I.executeScript(function() {
-// now we are inside browser context
-$('date').datetimepicker('setDate', new Date());
+  // now we are inside browser context
+  $('date').datetimepicker('setDate', new Date());
 });
 ```
 
@@ -341,14 +413,14 @@ Can return values. Don't forget to use `await` to get them.
 
 ```js
 let date = await I.executeScript(function(el) {
-// only basic types can be returned
-return $(el).datetimepicker('getDate').toString();
+  // only basic types can be returned
+  return $(el).datetimepicker('getDate').toString();
 }, '#date'); // passing jquery selector
 ```
 
 #### Parameters
 
--   `fn`  function to be executed in browser context.
+-   `fn` ([string][3] \| [function][7]) function to be executed in browser context.
 
 ### fillField
 
@@ -368,14 +440,16 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  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');
@@ -383,14 +457,19 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `attr`  attribute name.
+-   `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');
@@ -399,9 +478,13 @@ assert(cookie.value, '123456');
 
 #### Parameters
 
--   `name`  (optional) cookie name.Returns cookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object:```js
-    I.grabCookie({ secure: true});
-    ```If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
+-   `name`  cookie name. 
+
+Returns [Promise][8]&lt;[string][3]> attribute value
+
+
+
+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 }).`
 
 ### grabCurrentUrl
 
@@ -413,6 +496,10 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
+Returns [Promise][8]&lt;[string][3]> current URL
+
+
+
 ### grabHAR
 
 Get HAR
@@ -425,7 +512,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
@@ -436,31 +523,43 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 -   `locator`  element located by CSS|XPath|strict locator.
 
+Returns [Promise][8]&lt;[string][3]> HTML code for an element
+
+
+
 ### grabNumberOfVisibleElements
 
 Grab number of visible elements by locator.
 
 ```js
-I.grabNumberOfVisibleElements('p');
+let numOfElements = await I.grabNumberOfVisibleElements('p');
 ```
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][3] \| [object][4]) located by CSS|XPath|strict locator.
+
+Returns [Promise][8]&lt;[number][9]> 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
+
+
+
 ### 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');
@@ -472,19 +571,27 @@ If multiple elements found returns an array of texts.
 
 -   `locator`  element located by CSS|XPath|strict locator.
 
+Returns [Promise][8]&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
+
+
+
 ### 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]');
@@ -492,7 +599,11 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator`  field located by label|name|CSS|XPath|strict locator.
+-   `locator` ([string][3] \| [object][4]) field located by label|name|CSS|XPath|strict locator.
+
+Returns [Promise][8]&lt;[string][3]> attribute value
+
+
 
 ### haveHeader
 
@@ -520,13 +631,15 @@ I.moveCursorTo('#submit', 5,5);
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `offsetX`  (optional) X-axis offset.
--   `offsetY`  (optional) Y-axis offset.
+-   `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.
+    
+ 
 
 ### pressKey
 
-Sends [input event][5] on a page.
+Sends [input event][10] on a page.
 Can submit special keys like 'Enter', 'Backspace', etc
 
 #### Parameters
@@ -545,6 +658,9 @@ Reload the current page.
 I.refreshPage();
 ```
 
+
+
+
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -552,8 +668,10 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width`  width in pixels or `maximize`.
--   `height`  height in pixels.
+-   `width` [number][9] width in pixels or `maximize`.
+-   `height` [number][9] height in pixels.
+    
+
 
 ### rightClick
 
@@ -570,13 +688,15 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `locator`  clickable element located by CSS|XPath|strict locator.
--   `context`  (optional) 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
 
 Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder. 
+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.
 
 ```js
@@ -586,8 +706,10 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 #### Parameters
 
--   `fileName`  file name to save.
--   `fullPage`  (optional) flag to enable fullscreen screenshot mode.
+-   `fileName` [string][3] file name to save.
+-   `fullPage` [boolean][11] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+    
+ 
 
 ### scrollPageToBottom
 
@@ -597,6 +719,9 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
+
+
+
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -605,6 +730,9 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
+
+
+
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -617,9 +745,11 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `offsetX`  (optional) X-axis offset.
--   `offsetY`  (optional) Y-axis offset.
+-   `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.
+    
+ 
 
 ### see
 
@@ -634,8 +764,10 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 #### Parameters
 
--   `text`  expected on page.
--   `context`  (optional) 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
 
@@ -649,7 +781,9 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### seeCookie
 
@@ -661,7 +795,9 @@ I.seeCookie('Auth');
 
 #### Parameters
 
--   `name`  cookie name.
+-   `name` [string][3] cookie name.
+    
+
 
 ### seeCurrentUrlEquals
 
@@ -676,7 +812,9 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][3] value to check.
+    
+
 
 ### seeElement
 
@@ -689,7 +827,9 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][3] \| [object][4]) located by CSS|XPath|strict locator.
+    
+
 
 ### seeElementInDOM
 
@@ -702,7 +842,9 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+    
+
 
 ### seeInCurrentUrl
 
@@ -714,7 +856,9 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][3] a fragment to check
+    
+
 
 ### seeInField
 
@@ -730,8 +874,10 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  value to check.
+-   `field` ([string][3] \| [object][4]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][3] value to check.
+    
+
 
 ### seeInSource
 
@@ -743,19 +889,27 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text`  value to check.
+-   `text` [string][3] value to check.
+    
+
 
 ### seeInTitle
 
 Checks that title contains text.
 
+```js
+I.seeInTitle('Home Page');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][3] text value to check.
+    
+
 
 ### seeNumberOfElements
 
-asserts that an element appears a given number of times in the DOM
+Asserts that an element appears a given number of times in the DOM.
 Element is located by label or name or CSS or XPath.
 
 ```js
@@ -764,8 +918,10 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 #### Parameters
 
--   `selector`  
--   `num`  
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `num` [number][9] number of elements.
+    
+
 
 ### seeNumberOfVisibleElements
 
@@ -778,8 +934,10 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `num`  number of elements.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `num` [number][9] number of elements.
+    
+
 
 ### selectOption
 
@@ -804,8 +962,10 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select`  field located by label|name|CSS|XPath|strict locator.
--   `option`  visible text or value of option.
+-   `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.
+    
+
 
 ### setCookie
 
@@ -817,12 +977,14 @@ I.setCookie({name: 'auth', value: true});
 
 #### Parameters
 
--   `cookie`  cookie JSON object.Wrapper for `.cookies.set(cookie)`.
-    [See more][6]
+-   `cookie` [object][4] a cookie object.
+    
+Wrapper for `.cookies.set(cookie)`.
+    [See more][13]
 
 ### triggerMouseEvent
 
-Sends [input event][7] on a page.
+Sends [input event][14] on a page.
 Should be a mouse event like:
  {
 type: 'mouseDown',
@@ -835,6 +997,26 @@ button: "left"
 
 -   `event`  
 
+### uncheckOption
+
+Unselects a checkbox or radio button.
+Element is located by label or name or CSS or XPath.
+
+The second parameter is a context (CSS or XPath locator) to narrow the search.
+
+```js
+I.uncheckOption('#agree');
+I.uncheckOption('I Agree to Terms and Conditions');
+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.
+    
+ 
+
 ### wait
 
 Pauses execution for a number of seconds.
@@ -845,19 +1027,25 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec`  time in seconds to wait.
+-   `sec` [number][9] number of second to wait.
+    
+
 
 ### waitForDetached
 
 Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-    I.waitForDetached('#popup');
+```js
+I.waitForDetached('#popup');
+```
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `sec` [number][9] (optional, `1` by default) time in seconds to wait
+    
+
 
 ### waitForElement
 
@@ -871,8 +1059,10 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `sec` [number][9] (optional, `1` by default) time in seconds to wait
+    
+
 
 ### waitForFunction
 
@@ -891,21 +1081,27 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn`  to be executed in browser context.
--   `argsOrSec`  (optional) arguments for function or seconds.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `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
+    
+ 
 
 ### waitForInvisible
 
 Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-    I.waitForInvisible('#popup');
+```js
+I.waitForInvisible('#popup');
+```
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `sec` [number][9] (optional, `1` by default) time in seconds to wait
+    
+
 
 ### waitForText
 
@@ -920,44 +1116,68 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 #### Parameters
 
--   `text`  to wait for.
--   `sec`  (optional) time in seconds to wait.
--   `context`  (optional) element located by CSS|XPath|strict locator.
+-   `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.
+    
+ 
 
 ### waitForVisible
 
 Waits for an element to become visible on a page (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-    I.waitForVisible('#popup');
+```js
+I.waitForVisible('#popup');
+```
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `sec` [number][9] (optional, `1` by default) time in seconds to wait
+    
+
 
 ### waitToHide
 
 Waits for an element to hide (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-    I.waitToHide('#popup');
+```js
+I.waitToHide('#popup');
+```
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
+-   `locator` ([string][3] \| [object][4]) element located by CSS|XPath|strict locator.
+-   `sec` [number][9] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 [1]: https://github.com/segmentio/nightmare
 
 [2]: https://github.com/segmentio/nightmare#api
 
-[3]: https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[5]: https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs
+
+[6]: https://vuejs.org/v2/api/#Vue-nextTick
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[10]: http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent
 
-[4]: https://vuejs.org/v2/api/#Vue-nextTick
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[5]: http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[6]: https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie
+[13]: https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie
 
-[7]: http://electron.atom.io/docs/api/web-contents/#contentssendinputeventevent
+[14]: http://electron.atom.io/docs/api/web-contents/#contentssendinputeventevent