codeceptjs 2.1.3 → 2.2.1

package/docs/helpers/Appium.md

@@ -2,11 +2,12 @@
 id: Appium
 title: Appium
 ---
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## Appium
 
-**Extends Webdriver**
+Extends Webdriver
 
 Appium helper extends [Webriver][1] helper.
  It supports all browser methods and also includes special methods for mobile apps testing.
@@ -96,8 +97,10 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator
--   `value`  text value to append.
+-   `field` ([string][4] \| [object][5]) located by label|name|CSS|XPath|strict locator
+-   `value` [string][4] text value to append.
+    
+
 
 ### checkOption
 
@@ -114,8 +117,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][4] \| [object][5]) checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` [string][4] (optional, `null` by default) element located by CSS | XPath | strict locator.
+    
+
 
 ### click
 
@@ -134,7 +139,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
@@ -143,8 +148,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][4] \| [object][5]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` ([string][4] \| [object][5]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+    
+
 
 ### closeApp
 
@@ -162,40 +169,62 @@ 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][4] which is not present.
+-   `context` ([string][4] \| [object][5]) (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][4] \| [object][5]) located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### 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.
--   `context`  
+-   `locator` ([string][4] \| [object][5]) located by CSS|XPath|Strict locator.
+    
+
 
 ### 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][4] \| [object][5]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][4] value to check.
+    
+
 
 ### fillField
 
@@ -215,8 +244,10 @@ 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][4] \| [object][5]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][4] text value to fill.
+    
+
 
 ### grabAllContexts
 
@@ -281,7 +312,7 @@ Appium: support Android and iOS
 ### 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');
@@ -293,10 +324,14 @@ If multiple elements found returns an array of texts.
 
 -   `locator`  element located by CSS|XPath|strict locator.
 
+Returns [Promise][6]&lt;[string][4]> attribute value
+
+
+
 ### 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]');
@@ -304,7 +339,11 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator`  field located by label|name|CSS|XPath|strict locator.
+-   `locator` ([string][4] \| [object][5]) field located by label|name|CSS|XPath|strict locator.
+
+Returns [Promise][6]&lt;[string][4]> attribute value
+
+
 
 ### hideDeviceKeyboard
 
@@ -342,7 +381,7 @@ The Touch Action API provides the basis of all gestures that can be
 automated in Appium. At its core is the ability to chain together ad hoc
 individual actions, which will then be applied to an element in the
 application on the device.
-[See complete documentation][4]
+[See complete documentation][7]
 
 ```js
 I.makeTouchAction("~buttonStartWebviewCD", 'tap');
@@ -416,7 +455,7 @@ Perform a rotation gesture centered on the specified element.
 I.rotate(120, 120)
 ```
 
-See corresponding [webdriverio reference][5].
+See corresponding [webdriverio reference][8].
 
 Appium: support only iOS
 
@@ -442,7 +481,7 @@ I.runInWeb(() => {
 
 #### Parameters
 
--   `fn` **any** 
+-   `fn` any 
 
 ### runOnAndroid
 
@@ -477,8 +516,8 @@ I.runOnAndroid((caps) => {
 
 #### Parameters
 
--   `caps` **any** 
--   `fn` **any** 
+-   `caps` any 
+-   `fn` any 
 
 ### runOnIOS
 
@@ -513,8 +552,8 @@ I.runOnAndroid((caps) => {
 
 #### Parameters
 
--   `caps` **any** 
--   `fn` **any** 
+-   `caps` any 
+-   `fn` any 
 
 ### see
 
@@ -529,8 +568,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][4] expected on page.
+-   `context` ([string][4] \| [object][5]) (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+    
+
 
 ### seeAppIsInstalled
 
@@ -568,7 +609,9 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
+-   `field` ([string][4] \| [object][5]) located by label|name|CSS|XPath|strict locator.
+    
+
 
 ### seeCurrentActivityIs
 
@@ -615,7 +658,9 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator`  located by CSS|XPath|strict locator.
+-   `locator` ([string][4] \| [object][5]) located by CSS|XPath|strict locator.
+    
+
 
 ### seeInField
 
@@ -631,8 +676,10 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field`  located by label|name|CSS|XPath|strict locator.
--   `value`  value to check.
+-   `field` ([string][4] \| [object][5]) located by label|name|CSS|XPath|strict locator.
+-   `value` [string][4] value to check.
+    
+
 
 ### seeOrientationIs
 
@@ -670,13 +717,15 @@ 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.-   Supported on only for web testing!
+-   `select` ([string][4] \| [object][5]) field located by label|name|CSS|XPath|strict locator.
+-   `option` ([string][4] \| [array][9]) visible text or value of option.
+    
+-   Supported on only for web testing!
 
 ### sendDeviceKeyEvent
 
 Send a key event to the device.
-List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][6]
+List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][10]
 
 ```js
 I.sendDeviceKeyEvent(3);
@@ -690,7 +739,7 @@ I.sendDeviceKeyEvent(3);
 
 Set immediate value in app.
 
-See corresponding [webdriverio reference][7].
+See corresponding [webdriverio reference][11].
 
 Appium: support only iOS
 
@@ -715,7 +764,7 @@ I.setNetworkConnection(4) // airplane mode off, wifi off, data on
 I.setNetworkConnection(6) // airplane mode off, wifi on, data on
 ```
 
-See corresponding [webdriverio reference][8].
+See corresponding [webdriverio reference][12].
 
 Appium: support only Android
 
@@ -799,7 +848,7 @@ let locator = "#io.selendroid.testapp:id/LinearLayout1";
 I.swipe(locator, 800, 1200, 1000);
 ```
 
-[See complete reference][9]
+[See complete reference][13]
 
 #### Parameters
 
@@ -913,7 +962,7 @@ I.switchToNative('SOME_OTHER_CONTEXT');
 
 #### Parameters
 
--   `context` **any**  (optional, default `null`)
+-   `context` any  
 
 ### switchToWeb
 
@@ -930,7 +979,7 @@ I.switchToWeb('WEBVIEW_io.selendroid.testapp');
 
 #### Parameters
 
--   `context` **[string][10]?** 
+-   `context` [string][4]? 
 
 ### tap
 
@@ -944,7 +993,7 @@ Shortcut for `makeTouchAction`
 
 #### Parameters
 
--   `locator` **any** 
+-   `locator` any 
 
 ### touchPerform
 
@@ -989,20 +1038,26 @@ 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][4] \| [object][5]) element located by CSS|XPath|strict locator.
+-   `sec` [number][14] (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][4] \| [object][5]) element located by CSS|XPath|strict locator.
+-   `sec` [number][14] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 ### waitForText
 
@@ -1017,21 +1072,27 @@ 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][4] to wait for.
+-   `sec` [number][14] (optional, `1` by default) time in seconds to wait 
+-   `context` ([string][4] \| [object][5]) (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][4] \| [object][5]) element located by CSS|XPath|strict locator.
+-   `sec` [number][14] (optional, `1` by default) time in seconds to wait
+    
+ 
 
 [1]: http://codecept.io/helpers/WebDriver/
 
@@ -1039,16 +1100,24 @@ Element can be located by CSS or XPath.
 
 [3]: https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md
 
-[4]: http://webdriver.io/api/mobile/touchAction.html
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[7]: http://webdriver.io/api/mobile/touchAction.html
+
+[8]: http://webdriver.io/api/mobile/rotate.html
 
-[5]: http://webdriver.io/api/mobile/rotate.html
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[6]: https://developer.android.com/reference/android/view/KeyEvent.html
+[10]: https://developer.android.com/reference/android/view/KeyEvent.html
 
-[7]: http://webdriver.io/api/mobile/setImmediateValue.html
+[11]: http://webdriver.io/api/mobile/setImmediateValue.html
 
-[8]: http://webdriver.io/api/mobile/setNetworkConnection.html
+[12]: http://webdriver.io/api/mobile/setNetworkConnection.html
 
-[9]: http://webdriver.io/api/mobile/swipe.html
+[13]: http://webdriver.io/api/mobile/swipe.html
 
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number