codeceptjs 2.1.3 → 2.2.1

package/docs/helpers/WebDriverIO.md

@@ -2,11 +2,12 @@
 id: WebDriverIO
 title: WebDriverIO
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## WebDriverIO
 
-**Extends Helper**
+Extends Helper
 
 WebDriverIO helper which wraps [webdriverio][1] library to
 manipulate browser using Selenium WebDriver or PhantomJS.
@@ -19,22 +20,22 @@ This helper should be configured in codecept.json or codecept.conf.js
 
 -   `url`: base url of website to be tested.
 -   `browser`: browser in which to perform testing.
--   `host`: (optional, default: localhost) - WebDriver host to connect.
--   `port`: (optional, default: 4444) - WebDriver port to connect.
--   `protocol`: (optional, default: http) - protocol for WebDriver server.
--   `path`: (optional, default: /wd/hub) - path to WebDriver server,
--   `restart`: (optional, default: true) - restart browser between tests.
--   `smartWait`: (optional) **enables [SmartWait][3]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
--   `disableScreenshots`: (optional, default: false) - don't save screenshots on failure.
--   `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
--   `uniqueScreenshotNames`: (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites.
--   `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
--   `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` set to false.
+-   `host`:  - WebDriver host to connect.
+-   `port`:  - WebDriver port to connect.
+-   `protocol`:  - protocol for WebDriver server.
+-   `path`:  - path to WebDriver server,
+-   `restart`:  - restart browser between tests.
+-   `smartWait`: (optional) enables [SmartWait][3]; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+-   `disableScreenshots`:  - don't save screenshots on failure.
+-   `fullPageScreenshots`  - make full page screenshots on failure.
+-   `uniqueScreenshotNames`:  - option to prevent screenshot override if you have scenarios with the same name in different suites.
+-   `keepBrowserState`:  - keep browser state between tests when `restart` is set to false.
+-   `keepCookies`:  - keep cookies between tests when `restart` set to false.
 -   `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
--   `waitForTimeout`: (optional, default: 1000) sets default wait time in _ms_ for all `wait*` functions.
+-   `waitForTimeout`:  sets default wait time in _ms_ for all `wait` functions.
 -   `desiredCapabilities`: Selenium's [desired
     capabilities][4].
--   `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper
+-   `manualStart`:  - do not start browser before a test, start it manually inside a helper
     with `this.helpers["WebDriverIO"]._startBrowser()`.
 -   `timeouts`: [WebDriverIO timeouts][5] defined as hash.
 
@@ -210,7 +211,7 @@ this.helpers['WebDriverIO']._locate({name: 'password'}).then //...
 #### Parameters
 
 -   `locator`  element located by CSS|XPath|strict locator.
--   `smartWait`   (optional, default `false`)
+-   `smartWait`   
 
 ### \_locateCheckable
 
@@ -267,7 +268,9 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url`  url path or global url.
+-   `url` [string][10] url path or global url.
+    
+
     Appium: support only web testing
 
 ### appendField
@@ -281,8 +284,10 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator
--   `value`  text value to append.
+-   `field` ([string][10] \| [object][11]) located by label|name|CSS|XPath|strict locator
+-   `value` [string][10] text value to append.
+    
+
     Appium: support, but it's clear a field before insert in apps
 
 ### attachFile
@@ -298,8 +303,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.
+-   `locator` ([string][10] \| [object][11]) field located by label|name|CSS|XPath|strict locator.
+-   `pathToFile` [string][10] local file path relative to codecept.json config file.
+    
+
     Appium: not tested
 
 ### cancelPopup
@@ -322,39 +329,29 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field`  checkbox located by label | name | CSS | XPath | strict locator.
--   `context`  (optional) element located by CSS | XPath | strict locator.
-    Appium: not tested
+-   `field` ([string][10] \| [object][11]) checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` [string][10] (optional, `null` by default) element located by CSS | XPath | strict locator.
+    
 
-### clearCookie
+    Appium: not tested 
 
-Clears a cookie by name,
-if none provided clears all cookies.
+### clearCookie
 
-```js
-I.clearCookie();
-I.clearCookie('test');
-```
+{{> clearCookie}}
+Appium: support only web testing
 
 #### Parameters
 
--   `cookie`  (optional) cookie name.
-    Appium: support only web testing
+-   `cookie`  
 
 ### clearField
 
-Clears a `<textarea>` or text `<input>` element's value.
-
-```js
-I.clearField('Email');
-I.clearField('user[email]');
-I.clearField('#email');
-```
+{{> clearField}}
+Appium: support
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
-    Appium: support
+-   `field`  
 
 ### click
 
@@ -373,7 +370,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
@@ -382,9 +379,11 @@ 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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` ([string][10] \| [object][11]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    
+
+    Appium: support 
 
 ### closeCurrentTab
 
@@ -424,59 +423,82 @@ 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.
-    Appium: support with context in apps
+-   `text` [string][10] which is not present.
+-   `context` ([string][10] \| [object][11]) (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+
+    Appium: support with context in apps 
 
 ### 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][10] \| [object][11]) located by label|name|CSS|XPath|strict locator.
+    
+
     Appium: not tested
 
 ### dontSeeCookie
 
-Checks that cookie with given name does not exist.
+{{> dontSeeCookie}}
+Appium: support only web testing
 
 #### Parameters
 
--   `name`  cookie name.
-    Appium: support only web testing
+-   `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][10] value to check.
+    
+
     Appium: support only web testing
 
 ### dontSeeElement
 
-Opposite to `seeElement`. Checks that element is not visible (or in DOM)
+{{> dontSeeElement}}
+Appium: support
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|Strict locator.
-    Appium: support
+-   `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][10] \| [object][11]) located by CSS|XPath|Strict locator.
+    
+
     Appium: support
 
 ### dontSeeInCurrentUrl
@@ -485,7 +507,9 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][10] value to check.
+    
+
     Appium: support only web testing
 
 ### dontSeeInField
@@ -493,27 +517,48 @@ Checks that current url does not contain a provided fragment.
 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][10] \| [object][11]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][10] value to check.
+    
+
     Appium: support only web testing
 
 ### 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.Appium: support
+-   `text`  
+-   `value` [string][10] to check.
+    
+
+    Appium: support
 
 ### dontSeeInTitle
 
 Checks that title does not contain text.
 
+```js
+I.dontSeeInTitle('Error');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][10] value to check.
+    
+
     Appium: support only web testing
 
 ### doubleClick
@@ -530,9 +575,11 @@ 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.
-    Appium: support only web testing
+-   `locator` ([string][10] \| [object][11]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` ([string][10] \| [object][11]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    
+
+    Appium: support only web testing 
 
 ### dragAndDrop
 
@@ -544,8 +591,10 @@ I.dragAndDrop('#dragHandle', '#container');
 
 #### Parameters
 
--   `srcElement`  located by CSS|XPath|strict locator.
--   `destElement`  located by CSS|XPath|strict locator.
+-   `srcElement` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+-   `destElement` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+    
+
     Appium: not tested
 
 ### executeAsyncScript
@@ -553,11 +602,11 @@ I.dragAndDrop('#dragHandle', '#container');
 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][10].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][12].
 
 ```js
 I.executeAsyncScript(function(done) {
-Vue.nextTick(done); // waiting for next tick
+  Vue.nextTick(done); // waiting for next tick
 });
 ```
 
@@ -566,14 +615,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][10] \| [function][13]) function to be executed in browser context.
 
 ### executeScript
 
@@ -587,8 +636,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());
 });
 ```
 
@@ -596,14 +645,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][10] \| [function][13]) function to be executed in browser context.
 
 ### fillField
 
@@ -623,14 +672,17 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  text value to fill.Appium: support
+-   `field` ([string][10] \| [object][11]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][10] text value to fill.
+    
+
+    Appium: support
 
 ### 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');
@@ -638,9 +690,13 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `attr`  attribute name.
-    Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `attr` [string][10] attribute name.
+
+Returns [Promise][14]&lt;[string][10]> attribute value
+
+
+Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
 
 ### grabBrowserLogs
 
@@ -653,24 +709,17 @@ console.log(JSON.stringify(logs))
 
 ### 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.
-
-```js
-let cookie = await I.grabCookie('auth');
-assert(cookie.value, '123456');
-```
+{{> grabCookie}}
+Appium: support only web testing
 
 #### Parameters
 
--   `name`  (optional) cookie name.
-    Appium: support only web testing
+-   `name`  
 
 ### 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');
@@ -678,8 +727,12 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `cssProperty`  CSS property name.
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `cssProperty` [string][10] CSS property name.
+
+Returns [Promise][14]&lt;[string][10]> CSS value
+
+
 
 ### grabCurrentUrl
 
@@ -691,10 +744,14 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
+Returns [Promise][14]&lt;[string][10]> current URL
+
+
+
 ### 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
@@ -704,36 +761,43 @@ let postHTML = await I.grabHTMLFrom('#post');
 #### Parameters
 
 -   `locator`  element located by CSS|XPath|strict locator.
-    Appium: support only web testing
+
+Returns [Promise][14]&lt;[string][10]> HTML code for an element
+
+
+Appium: support only web testing
 
 ### grabNumberOfOpenTabs
 
 Grab number of open tabs.
 
 ```js
-I.grabNumberOfOpenTabs();
+let tabs = await I.grabNumberOfOpenTabs();
 ```
 
+Returns [Promise][14]&lt;[number][15]> number of open tabs
+
+
+
 ### 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][10] \| [object][11]) located by CSS|XPath|strict locator.
 
-### grabPageScrollPosition
+Returns [Promise][14]&lt;[number][15]> number of visible elements
 
-Retrieves a page scroll position and returns it to test.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
 
-```js
-let { x, y } = await I.grabPageScrollPosition();
-```
+
+### grabPageScrollPosition
+
+{{> grabPageScrollPosition}}
 
 ### grabPopupText
 
@@ -752,12 +816,15 @@ Resumes test execution, so should be used inside an async function.
 let pageSource = await I.grabSource();
 ```
 
+Returns [Promise][14]&lt;[string][10]> source code
+
+
 Appium: support
 
 ### 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');
@@ -768,23 +835,30 @@ If multiple elements found returns an array of texts.
 #### Parameters
 
 -   `locator`  element located by CSS|XPath|strict locator.
-    Appium: support
+
+Returns [Promise][14]&lt;[string][10]> attribute value
+
+
+Appium: support
 
 ### 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][14]&lt;[string][10]> title
+
+
 Appium: support only web testing
 
 ### 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]');
@@ -792,25 +866,23 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator`  field located by label|name|CSS|XPath|strict locator.
-    Appium: support only web testing
+-   `locator` ([string][10] \| [object][11]) field located by label|name|CSS|XPath|strict locator.
 
-### moveCursorTo
+Returns [Promise][14]&lt;[string][10]> attribute value
 
-Moves cursor to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
 
-```js
-I.moveCursorTo('.tooltip');
-I.moveCursorTo('#submit', 5,5);
-```
+Appium: support only web testing
+
+### moveCursorTo
+
+{{> moveCursorTo}}
+Appium: support only web testing
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `offsetX`  (optional) X-axis offset.
--   `offsetY`  (optional) Y-axis offset.
-    Appium: support only web testing
+-   `locator`  
+-   `offsetX`   
+-   `offsetY`   
 
 ### openNewTab
 
@@ -823,7 +895,7 @@ I.openNewTab();
 ### pressKey
 
 Presses a key on a focused element.
-Special keys like 'Enter', 'Control', [etc][11]
+Special keys like 'Enter', 'Control', [etc][16]
 will be replaced with corresponding unicode.
 If modifier key is used (Control, Command, Alt, Shift) in array, it will be released afterwards.
 
@@ -834,36 +906,10 @@ I.pressKey(['Control','a']);
 
 #### Parameters
 
--   `key`  key or array of keys to press.
-    [Valid key names][12] are:-   `'Add'`,
-    -   `'Alt'`,
-    -   `'ArrowDown'` or `'Down arrow'`,
-    -   `'ArrowLeft'` or `'Left arrow'`,
-    -   `'ArrowRight'` or `'Right arrow'`,
-    -   `'ArrowUp'` or `'Up arrow'`,
-    -   `'Backspace'`,
-    -   `'Command'`,
-    -   `'Control'`,
-    -   `'Del'`,
-    -   `'Divide'`,
-    -   `'End'`,
-    -   `'Enter'`,
-    -   `'Equals'`,
-    -   `'Escape'`,
-    -   `'F1 to F12'`,
-    -   `'Home'`,
-    -   `'Insert'`,
-    -   `'Meta'`,
-    -   `'Multiply'`,
-    -   `'Numpad 0'` to `'Numpad 9'`,
-    -   `'Pagedown'` or `'PageDown'`,
-    -   `'Pageup'` or `'PageUp'`,
-    -   `'Pause'`,
-    -   `'Semicolon'`,
-    -   `'Shift'`,
-    -   `'Space'`,
-    -   `'Subtract'`,
-    -   `'Tab'`.To make combinations with modifier and mouse clicks (like Ctrl+Click) press a modifier, click, then release it.
+-   `key` ([string][10] \| [array][17]) key or array of keys to press.
+    
+
+    {{> \_keys }}To make combinations with modifier and mouse clicks (like Ctrl+Click) press a modifier, click, then release it.
     Appium: support, but clear field before pressing in apps:```js
     I.pressKey('Control');
     I.click('#someelement');
@@ -878,6 +924,9 @@ Reload the current page.
 I.refreshPage();
 ```
 
+
+
+
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -885,8 +934,10 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width`  width in pixels or `maximize`.
--   `height`  height in pixels.
+-   `width` [number][15] width in pixels or `maximize`.
+-   `height` [number][15] height in pixels.
+    
+
     Appium: not tested in web, in apps doesn't work
 
 ### rightClick
@@ -904,8 +955,11 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `locator`  clickable element located by CSS|XPath|strict locator.
--   `context`  (optional) element located by CSS|XPath|strict locator.Appium: support, but in apps works as usual click
+-   `locator` ([string][10] \| [object][11]) clickable element located by CSS|XPath|strict locator.
+-   `context` ([string][10] \| [object][11]) (optional, `null` by default) element located by CSS|XPath|strict locator.
+    
+
+    Appium: support, but in apps works as usual click
 
 ### runInWeb
 
@@ -935,20 +989,13 @@ Placeholder for ~ locator only test case write once run on both Appium and WebDr
 
 ### saveScreenshot
 
-Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder. 
-Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
-
-```js
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
+{{> saveScreenshot}}
+Appium: support
 
 #### Parameters
 
--   `fileName`  file name to save.
--   `fullPage`  (optional) flag to enable fullscreen screenshot mode.
-    Appium: support
+-   `fileName`  
+-   `fullPage`   
 
 ### scrollPageToBottom
 
@@ -958,6 +1005,9 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
+
+
+
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -966,6 +1016,9 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
+
+
+
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -994,10 +1047,12 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `offsetX`  (optional) X-axis offset.
--   `offsetY`  (optional) Y-axis offset.
-    Appium: support only web testing
+-   `locator` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+-   `offsetX` [number][15] (optional, `0` by default) X-axis offset. 
+-   `offsetY` [number][15] (optional, `0` by default) Y-axis offset.
+    
+
+    Appium: support only web testing 
 
 ### see
 
@@ -1012,22 +1067,26 @@ 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.
-    Appium: support with context in apps
+-   `text` [string][10] expected on page.
+-   `context` ([string][10] \| [object][11]) (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+    
+
+    Appium: support with context in apps 
 
 ### seeAttributesOnElements
 
 Checks that all elements with given locator have given attributes.
 
 ```js
-I.seeAttributesOnElements('//form', {'method': "post"});
+I.seeAttributesOnElements('//form', { method: "post"});
 ```
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `attributes`  object with attributes and their values to check.
+-   `locator` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+-   `attributes` [object][11] attributes and their values to check.
+    
+
 
 ### seeCheckboxIsChecked
 
@@ -1041,21 +1100,19 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field` ([string][10] \| [object][11]) located by label|name|CSS|XPath|strict locator.
+    
+
     Appium: not tested
 
 ### seeCookie
 
-Checks that cookie with given name exists.
-
-```js
-I.seeCookie('Auth');
-```
+{{> seeCookie}}
+Appium: support only web testing
 
 #### Parameters
 
--   `name`  cookie name.
-    Appium: support only web testing
+-   `name`  
 
 ### seeCssPropertiesOnElements
 
@@ -1067,8 +1124,10 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
--   `cssProperties`  object with CSS properties and their values to check.
+-   `locator` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+-   `cssProperties` [object][11] object with CSS properties and their values to check.
+    
+
 
 ### seeCurrentUrlEquals
 
@@ -1083,7 +1142,9 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][10] value to check.
+    
+
     Appium: support only web testing
 
 ### seeElement
@@ -1097,7 +1158,9 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][10] \| [object][11]) located by CSS|XPath|strict locator.
+    
+
     Appium: support
 
 ### seeElementInDOM
@@ -1111,7 +1174,9 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+    
+
     Appium: support
 
 ### seeInCurrentUrl
@@ -1124,7 +1189,9 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][10] a fragment to check
+    
+
     Appium: support only web testing
 
 ### seeInField
@@ -1141,8 +1208,10 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  value to check.
+-   `field` ([string][10] \| [object][11]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][10] value to check.
+    
+
     Appium: support only web testing
 
 ### seeInPopup
@@ -1164,16 +1233,24 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text`  value to check.
+-   `text` [string][10] value to check.
+    
+
     Appium: support
 
 ### seeInTitle
 
 Checks that title contains text.
 
+```js
+I.seeInTitle('Home Page');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][10] text value to check.
+    
+
     Appium: support only web testing
 
 ### seeNumberOfElements
@@ -1202,8 +1279,10 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `num`  number of elements.
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `num` [number][15] number of elements.
+    
+
 
 ### seeTextEquals
 
@@ -1232,51 +1311,39 @@ I.seeTitleEquals('Test title.');
 
 ### selectOption
 
-Selects an option in a drop-down select.
-Field is searched by label | name | CSS | XPath.
-Option is selected by visible text or by value.
-
-```js
-I.selectOption('Choose Plan', 'Monthly'); // select by label
-I.selectOption('subscription', 'Monthly'); // match option by text
-I.selectOption('subscription', '0'); // or by value
-I.selectOption('//form/select[@name=account]','Premium');
-I.selectOption('form select[name=account]', 'Premium');
-I.selectOption({css: 'form select[name=account]'}, 'Premium');
-```
-
-Provide an array for the second argument to select multiple options.
-
-```js
-I.selectOption('Which OS do you use?', ['Android', 'iOS']);
-```
+{{> selectOption}}
 
 #### Parameters
 
--   `select`  field located by label|name|CSS|XPath|strict locator.
--   `option`  visible text or value of option.
+-   `select`  
+-   `option`  
 
 ### setCookie
 
-Sets a cookie.
+{{> setCookie}}
+Appium: support only web testing
 
-```js
-I.setCookie({name: 'auth', value: true});
-```
+Uses Selenium's JSON [cookie
+format][18].
 
 #### Parameters
 
--   `cookie`  cookie JSON object.
-    Appium: support only web testingUses Selenium's JSON [cookie
-    format][13].
+-   `cookie`  
 
 ### switchTo
 
 Switches frame or in case of null locator reverts to parent.
 
+```js
+I.switchTo('iframe'); // switch to first iframe
+I.switchTo(); // switch back to main page
+```
+
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` ([string][10] \| [object][11]) (optional, `null` by default) element located by CSS|XPath|strict locator.
+    
+
     Appium: support only web testing
 
 ### switchToNextTab
@@ -1322,9 +1389,11 @@ I.uncheckOption('agree', '//form');
 
 #### Parameters
 
--   `field`  checkbox located by label | name | CSS | XPath | strict locator.
--   `context`  (optional) element located by CSS | XPath | strict locator.
-    Appium: not tested
+-   `field` ([string][10] \| [object][11]) checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` [string][10] (optional, `null` by default) element located by CSS | XPath | strict locator.
+    
+
+    Appium: not tested 
 
 ### wait
 
@@ -1336,7 +1405,9 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec`  time in seconds to wait.
+-   `sec` [number][15] number of second to wait.
+    
+
     Appium: support
 
 ### waitForDetached
@@ -1344,13 +1415,17 @@ I.wait(2); // wait 2 secs
 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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### waitForElement
 
@@ -1364,9 +1439,11 @@ 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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### waitForEnabled
 
@@ -1375,8 +1452,10 @@ Element can be located by CSS or XPath.
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
 -   `sec`  (optional) time in seconds to wait, 1 by default.
+    
+
     Appium: support
 
 ### waitForFunction
@@ -1396,23 +1475,29 @@ 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.
-    Appium: support
+-   `fn` ([string][10] \| [function][13]) to be executed in browser context.
+-   `argsOrSec` ([array][17] \| [number][15]) (optional, `1` by default) arguments for function or seconds. 
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### 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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### waitForText
 
@@ -1427,10 +1512,12 @@ 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.
-    Appium: support
+-   `text` [string][10] to wait for.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait 
+-   `context` ([string][10] \| [object][11]) (optional) element located by CSS|XPath|strict locator.
+    
+
+    Appium: support 
 
 ### waitForValue
 
@@ -1442,22 +1529,28 @@ I.waitForValue('//input', "GoodValue");
 
 #### Parameters
 
--   `field`  input field.
--   `value`  expected value.
--   `sec`  (optional) time in seconds to wait, 1 sec by default.
+-   `field` ([string][10] \| [object][11]) input field.
+-   `value` [string][10] expected value.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### 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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### waitInUrl
 
@@ -1469,8 +1562,10 @@ I.waitInUrl('/info', 2);
 
 #### Parameters
 
--   `urlPart`  value to check.
--   `sec`  (optional) time in seconds to wait.
+-   `urlPart` [string][10] value to check.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitNumberOfVisibleElements
 
@@ -1482,22 +1577,28 @@ I.waitNumberOfVisibleElements('a', 3);
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `num`  number of elements.
--   `sec`  (optional) time in seconds to wait.
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `num` [number][15] number of elements.
+-   `sec` [number][15] (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.
-    Appium: support
+-   `locator` ([string][10] \| [object][11]) element located by CSS|XPath|strict locator.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+
+    Appium: support 
 
 ### waitUntil
 
@@ -1510,9 +1611,11 @@ I.waitUntil(() => window.requests == 0, 5);
 
 #### Parameters
 
--   `fn`  function which is executed in browser context.
--   `sec`  (optional) time in seconds to wait, 1 by default.
--   `timeoutMsg`  (optional) message to show in case of timeout fail.
+-   `fn` ([function][13] \| [string][10]) function which is executed in browser context.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait 
+-   `timeoutMsg` [string][10] message to show in case of timeout fail.
+    
+ 
 -   `interval`  (optional) time in seconds between condition checks.-   _Appium_: supported
 
 ### waitUrlEquals
@@ -1526,8 +1629,10 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 #### Parameters
 
--   `urlPart`  value to check.
--   `sec`  (optional) time in seconds to wait.
+-   `urlPart` [string][10] value to check.
+-   `sec` [number][15] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 [1]: http://webdriver.io/
 
@@ -1547,10 +1652,20 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [9]: http://jster.net/category/windows-modals-popups
 
-[10]: https://vuejs.org/v2/api/#Vue-nextTick
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[12]: https://vuejs.org/v2/api/#Vue-nextTick
+
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[11]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value
+[16]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value
 
-[12]: https://w3c.github.io/webdriver/#keyboard-actions
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[13]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object
+[18]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object