codeceptjs 2.1.3 → 2.2.1

package/docs/helpers/Protractor.md

@@ -2,11 +2,12 @@
 id: Protractor
 title: Protractor
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## Protractor
 
-**Extends Helper**
+Extends Helper
 
 Protractor helper is based on [Protractor library][1] and used for testing web applications.
 
@@ -19,21 +20,21 @@ This helper should be configured in codecept.json or codecept.conf.js
 
 -   `url` - base url of website to be tested
 -   `browser` - browser in which perform testing
--   `angular` (optional, default: true): disable this option to run tests for non-Angular applications.
+-   `angular` : disable this option to run tests for non-Angular applications.
 -   `driver` - which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started.
--   `restart` (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 screenshot 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` set to false.
+-   `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 screenshot 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` set to false.
 -   `seleniumAddress` - Selenium address to connect (default: [http://localhost:4444/wd/hub][4])
 -   `rootElement` - Root element of AngularJS application (default: body)
 -   `getPageTimeout` (optional) sets default timeout for a page to be loaded. 10000 by default.
--   `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait*` functions. 1000 by default.
+-   `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait` functions. 1000 by default.
 -   `scriptsTimeout`: (optional) timeout in milliseconds for each script run on the browser, 10000 by default.
 -   `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
--   `manualStart` (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
+-   `manualStart`  - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
 -   `capabilities`: {} - list of [Desired Capabilities][5]
 -   `proxy`: set proxy settings
 
@@ -106,7 +107,7 @@ Get the window handle relative to the current handle. i.e. the next handle or th
 
 #### Parameters
 
--   `offset` **[Number][7]** Offset from current handle index. i.e. offset &lt; 0 will go to the previous handle and positive number will go to the next window handle in sequence. (optional, default `0`)
+-   `offset` [Number][7] Offset from current handle index. i.e. offset &lt; 0 will go to the previous handle and positive number will go to the next window handle in sequence. 
 
 ### \_locate
 
@@ -126,7 +127,7 @@ this.helpers['Protractor']._locate({name: 'password'}, true).then //...
 #### Parameters
 
 -   `locator`  
--   `smartWait`   (optional, default `false`)
+-   `smartWait`   
 
 ### \_locateCheckable
 
@@ -188,7 +189,9 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url`  url path or global url.
+-   `url` [string][9] url path or global url.
+    
+
 
 ### amOutsideAngularApp
 
@@ -206,8 +209,10 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator
--   `value`  text value to append.
+-   `field` ([string][9] \| [object][10]) located by label|name|CSS|XPath|strict locator
+-   `value` [string][9] text value to append.
+    
+
 
 ### attachFile
 
@@ -222,8 +227,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][9] \| [object][10]) field located by label|name|CSS|XPath|strict locator.
+-   `pathToFile` [string][9] local file path relative to codecept.json config file.
+    
+
 
 ### cancelPopup
 
@@ -244,8 +251,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][9] \| [object][10]) checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` [string][9] (optional, `null` by default) element located by CSS | XPath | strict locator.
+    
+ 
 
 ### clearCookie
 
@@ -259,7 +268,9 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie`  (optional) cookie name.
+-   `cookie` [string][9] (optional, `null` by default) cookie name
+    
+ 
 
 ### clearField
 
@@ -273,7 +284,10 @@ I.clearField('#email');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field`  
+-   `editable` ([string][9] \| [object][10]) field located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### click
 
@@ -292,7 +306,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
@@ -301,8 +315,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][9] \| [object][10]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` ([string][9] \| [object][10]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    
+ 
 
 ### closeCurrentTab
 
@@ -326,54 +342,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][9] which is not present.
+-   `context` ([string][9] \| [object][10]) (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][9] \| [object][10]) 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][9] 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][9] 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][9] \| [object][10]) 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][9] \| [object][10]) located by CSS|XPath|Strict locator.
+    
+
 
 ### dontSeeInCurrentUrl
 
@@ -381,33 +432,55 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][9] 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][9] \| [object][10]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][9] 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][9] to check.
+    
+
 
 ### dontSeeInTitle
 
 Checks that title does not contain text.
 
+```js
+I.dontSeeInTitle('Error');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][9] value to check.
+    
+
 
 ### doubleClick
 
@@ -423,8 +496,10 @@ 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][9] \| [object][10]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` ([string][9] \| [object][10]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    
+ 
 
 ### dragAndDrop
 
@@ -436,19 +511,21 @@ I.dragAndDrop('#dragHandle', '#container');
 
 #### Parameters
 
--   `srcElement`  located by CSS|XPath|strict locator.
--   `destElement`  located by CSS|XPath|strict locator.
+-   `srcElement` ([string][9] \| [object][10]) located by CSS|XPath|strict locator.
+-   `destElement` ([string][9] \| [object][10]) located by 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][9].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][11].
 
 ```js
 I.executeAsyncScript(function(done) {
-Vue.nextTick(done); // waiting for next tick
+  Vue.nextTick(done); // waiting for next tick
 });
 ```
 
@@ -457,14 +534,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][9] \| [function][12]) function to be executed in browser context.
 
 ### executeScript
 
@@ -478,8 +555,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());
 });
 ```
 
@@ -487,14 +564,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][9] \| [function][12]) function to be executed in browser context.
 
 ### fillField
 
@@ -514,14 +591,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][9] \| [object][10]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][9] 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');
@@ -529,24 +608,33 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `attr`  attribute name.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `attr` [string][9] attribute name.
+
+Returns [Promise][13]&lt;[string][9]> attribute value
+
+
 
 ### grabBrowserLogs
 
 Get JS log from browser. Log buffer is reset after each request.
-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 logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
+Returns [Promise][13]&lt;[Array][14]> all browser 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.
+
+-   Resumes test execution, so should be used inside async with `await` operator.
 
 ```js
 let cookie = await I.grabCookie('auth');
@@ -555,12 +643,16 @@ assert(cookie.value, '123456');
 
 #### Parameters
 
--   `name`  (optional) cookie name.Returns cookie in JSON [format][10].
+-   `name`  cookie name. 
+
+Returns [Promise][13]&lt;[string][9]> attribute value
+
+Returns cookie in JSON [format][15].
 
 ### 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');
@@ -568,8 +660,12 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `cssProperty`  CSS property name.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `cssProperty` [string][9] CSS property name.
+
+Returns [Promise][13]&lt;[string][9]> CSS value
+
+
 
 ### grabCurrentUrl
 
@@ -581,10 +677,14 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
+Returns [Promise][13]&lt;[string][9]> 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
@@ -595,35 +695,51 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 -   `locator`  element located by CSS|XPath|strict locator.
 
+Returns [Promise][13]&lt;[string][9]> HTML code for an element
+
+
+
 ### grabNumberOfOpenTabs
 
 Grab number of open tabs.
 
 ```js
-I.grabNumberOfOpenTabs();
+let tabs = await I.grabNumberOfOpenTabs();
 ```
 
+Returns [Promise][13]&lt;[number][7]> 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][9] \| [object][10]) located by CSS|XPath|strict locator.
+
+Returns [Promise][13]&lt;[number][7]> 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][13]&lt;[object][10]> scroll position
+
+
+
 ### grabPopupText
 
 Grab the text within the popup. If no popup is visible then it will return null
@@ -641,10 +757,14 @@ Resumes test execution, so should be used inside an async function.
 let pageSource = await I.grabSource();
 ```
 
+Returns [Promise][13]&lt;[string][9]> source code
+
+
+
 ### grabTextFrom
 
 Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
+Resumes test execution, so should be used inside async with `await` operator.
 
 ```js
 let pin = await I.grabTextFrom('#pin');
@@ -656,19 +776,27 @@ If multiple elements found returns an array of texts.
 
 -   `locator`  element located by CSS|XPath|strict locator.
 
+Returns [Promise][13]&lt;[string][9]> 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][13]&lt;[string][9]> 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]');
@@ -676,7 +804,11 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator`  field located by label|name|CSS|XPath|strict locator.
+-   `locator` ([string][9] \| [object][10]) field located by label|name|CSS|XPath|strict locator.
+
+Returns [Promise][13]&lt;[string][9]> attribute value
+
+
 
 ### haveModule
 
@@ -705,9 +837,11 @@ 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][9] \| [object][10]) located by CSS|XPath|strict locator.
+-   `offsetX` [number][7] (optional, `0` by default) X-axis offset. 
+-   `offsetY` [number][7] (optional, `0` by default) Y-axis offset.
+    
+ 
 
 ### moveTo
 
@@ -728,7 +862,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.
 
@@ -739,36 +873,43 @@ 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'`.
+-   `key` ([string][9] \| [array][14]) key or array of keys to press.
+    
+
+    
+
+
+[Valid key names](https://w3c.github.io/webdriver/#keyboard-actions) 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'`.
 
 ### refresh
 
@@ -782,6 +923,9 @@ Reload the current page.
 I.refreshPage();
 ```
 
+
+
+
 ### resetModule
 
 Removes mocked Angular module. If modName not specified - clears all mock modules.
@@ -802,8 +946,10 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width`  width in pixels or `maximize`.
--   `height`  height in pixels.
+-   `width` [number][7] width in pixels or `maximize`.
+-   `height` [number][7] height in pixels.
+    
+
 
 ### rightClick
 
@@ -820,13 +966,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][9] \| [object][10]) clickable element located by CSS|XPath|strict locator.
+-   `context` ([string][9] \| [object][10]) (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
@@ -836,8 +984,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][9] file name to save.
+-   `fullPage` [boolean][17] (optional, `false` by default) flag to enable fullscreen screenshot mode.
+    
+ 
 
 ### scrollPageToBottom
 
@@ -847,6 +997,9 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
+
+
+
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -855,6 +1008,9 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
+
+
+
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -867,9 +1023,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][9] \| [object][10]) located by CSS|XPath|strict locator.
+-   `offsetX` [number][7] (optional, `0` by default) X-axis offset. 
+-   `offsetY` [number][7] (optional, `0` by default) Y-axis offset.
+    
+ 
 
 ### see
 
@@ -884,21 +1042,25 @@ 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][9] expected on page.
+-   `context` ([string][9] \| [object][10]) (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+    
+ 
 
 ### 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][9] \| [object][10]) located by CSS|XPath|strict locator.
+-   `attributes` [object][10] attributes and their values to check.
+    
+
 
 ### seeCheckboxIsChecked
 
@@ -912,7 +1074,9 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field` ([string][9] \| [object][10]) located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### seeCookie
 
@@ -924,7 +1088,9 @@ I.seeCookie('Auth');
 
 #### Parameters
 
--   `name`  cookie name.
+-   `name` [string][9] cookie name.
+    
+
 
 ### seeCssPropertiesOnElements
 
@@ -936,8 +1102,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][9] \| [object][10]) located by CSS|XPath|strict locator.
+-   `cssProperties` [object][10] object with CSS properties and their values to check.
+    
+
 
 ### seeCurrentUrlEquals
 
@@ -952,7 +1120,9 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][9] value to check.
+    
+
 
 ### seeElement
 
@@ -965,7 +1135,9 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][9] \| [object][10]) located by CSS|XPath|strict locator.
+    
+
 
 ### seeElementInDOM
 
@@ -978,7 +1150,9 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+    
+
 
 ### seeInCurrentUrl
 
@@ -990,7 +1164,9 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url`  value to check.
+-   `url` [string][9] a fragment to check
+    
+
 
 ### seeInField
 
@@ -1006,8 +1182,10 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  value to check.
+-   `field` ([string][9] \| [object][10]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][9] value to check.
+    
+
 
 ### seeInPopup
 
@@ -1028,19 +1206,27 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text`  value to check.
+-   `text` [string][9] value to check.
+    
+
 
 ### seeInTitle
 
 Checks that title contains text.
 
+```js
+I.seeInTitle('Home Page');
+```
+
 #### Parameters
 
--   `text`  text value to check.
+-   `text` [string][9] 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
@@ -1049,8 +1235,10 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 #### Parameters
 
--   `selector`  
--   `num`  
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `num` [number][7] number of elements.
+    
+
 
 ### seeNumberOfVisibleElements
 
@@ -1063,8 +1251,10 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
--   `num`  number of elements.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `num` [number][7] number of elements.
+    
+
 
 ### seeTextEquals
 
@@ -1077,7 +1267,7 @@ I.seeTextEquals('text', 'h1');
 #### Parameters
 
 -   `text`  
--   `context`   (optional, default `null`)
+-   `context`   
 
 ### seeTitleEquals
 
@@ -1114,8 +1304,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][9] \| [object][10]) field located by label|name|CSS|XPath|strict locator.
+-   `option` ([string][9] \| [array][14]) visible text or value of option.
+    
+
 
 ### setCookie
 
@@ -1127,15 +1319,24 @@ I.setCookie({name: 'auth', value: true});
 
 #### Parameters
 
--   `cookie`  cookie JSON object.
+-   `cookie` [object][10] a cookie object.
+    
+
 
 ### 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][9] \| [object][10]) (optional, `null` by default) element located by CSS|XPath|strict locator.
+    
+
 
 ### switchToNextTab
 
@@ -1148,7 +1349,7 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num`   (optional, default `1`)
+-   `num`   
 
 ### switchToPreviousTab
 
@@ -1161,7 +1362,27 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num`   (optional, default `1`)
+-   `num`   
+
+### 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][9] \| [object][10]) checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` [string][9] (optional, `null` by default) element located by CSS | XPath | strict locator.
+    
+ 
 
 ### wait
 
@@ -1173,7 +1394,9 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec`  time in seconds to wait.
+-   `sec` [number][7] number of second to wait.
+    
+
 
 ### waitForClickable
 
@@ -1186,19 +1409,23 @@ I.waitForClickable('#link');
 #### Parameters
 
 -   `locator`  
--   `sec`   (optional, default `null`)
+-   `sec`   
 
 ### 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][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitForElement
 
@@ -1212,8 +1439,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][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitForEnabled
 
@@ -1222,8 +1451,10 @@ Element can be located by CSS or XPath.
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
 -   `sec`  (optional) time in seconds to wait, 1 by default.
+    
+
 
 ### waitForFunction
 
@@ -1242,21 +1473,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][9] \| [function][12]) to be executed in browser context.
+-   `argsOrSec` ([array][14] \| [number][7]) (optional, `1` by default) arguments for function or seconds. 
+-   `sec` [number][7] (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][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitForText
 
@@ -1271,9 +1508,11 @@ 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][9] to wait for.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait 
+-   `context` ([string][9] \| [object][10]) (optional) element located by CSS|XPath|strict locator.
+    
+ 
 
 ### waitForValue
 
@@ -1285,21 +1524,27 @@ I.waitForValue('//input', "GoodValue");
 
 #### Parameters
 
--   `field`  input field.
--   `value`  expected value.
--   `sec`  (optional) time in seconds to wait, 1 sec by default.
+-   `field` ([string][9] \| [object][10]) input field.
+-   `value` [string][9] expected value.
+-   `sec` [number][7] (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.
+-   `locator` ([string][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitInUrl
 
@@ -1311,8 +1556,10 @@ I.waitInUrl('/info', 2);
 
 #### Parameters
 
--   `urlPart`  value to check.
--   `sec`  (optional) time in seconds to wait.
+-   `urlPart` [string][9] value to check.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitNumberOfVisibleElements
 
@@ -1324,21 +1571,27 @@ 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][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `num` [number][7] number of elements.
+-   `sec` [number][7] (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][9] \| [object][10]) element located by CSS|XPath|strict locator.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitUntil
 
@@ -1351,9 +1604,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][12] \| [string][9]) function which is executed in browser context.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait 
+-   `timeoutMsg` [string][9] message to show in case of timeout fail.
+    
+ 
 
 ### waitUrlEquals
 
@@ -1366,8 +1621,10 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 #### Parameters
 
--   `urlPart`  value to check.
--   `sec`  (optional) time in seconds to wait.
+-   `urlPart` [string][9] value to check.
+-   `sec` [number][7] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ## perform
 
@@ -1389,10 +1646,20 @@ just press button if no selector is given
 
 [8]: http://jster.net/category/windows-modals-popups
 
-[9]: https://vuejs.org/v2/api/#Vue-nextTick
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[11]: https://vuejs.org/v2/api/#Vue-nextTick
+
+[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[10]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object
+[15]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object
 
-[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/Boolean