codeceptjs 3.3.6 → 3.3.7

package/docs/helpers/Appium.md

@@ -201,6 +201,20 @@ I.runInWeb(() => {
 
 -   `fn` **any** 
 
+### checkIfAppIsInstalled
+
+Returns app installation status.
+
+```js
+I.checkIfAppIsInstalled("com.example.android.apis");
+```
+
+#### Parameters
+
+-   `bundleId` **[string][4]** String  ID of bundled app
+
+Returns **[Promise][5]<[boolean][6]>** Appium: support only Android
+
 ### seeAppIsInstalled
 
 Check if an app is installed.
@@ -258,6 +272,14 @@ Appium: support only Android
 -   `appId` **[string][4]** 
 -   `bundleId` **[string][4]?** ID of bundle
 
+### resetApp
+
+Reset the currently running app for current session.
+
+```js
+I.resetApp();
+```
+
 ### seeCurrentActivityIs
 
 Check current activity on an Android device.
@@ -326,7 +348,7 @@ Get list of all available contexts
 
     let contexts = await I.grabAllContexts();
 
-Returns **[Promise][5]<[Array][6]<[string][4]>>** Appium: support Android and iOS
+Returns **[Promise][5]<[Array][7]<[string][4]>>** Appium: support Android and iOS
 
 ### grabContext
 
@@ -458,7 +480,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][7].
+See corresponding [webdriverio reference][8].
 
 #### Parameters
 
@@ -476,7 +498,7 @@ I.setSettings({cyberdelia: 'open'});
 
 #### Parameters
 
--   `settings` **[object][8]** objectAppium: support Android and iOS
+-   `settings` **[object][9]** objectAppium: support Android and iOS
 
 ### hideDeviceKeyboard
 
@@ -501,7 +523,7 @@ Appium: support Android and iOS
 ### sendDeviceKeyEvent
 
 Send a key event to the device.
-List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][9]
+List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][10]
 
 ```js
 I.sendDeviceKeyEvent(3);
@@ -509,7 +531,7 @@ I.sendDeviceKeyEvent(3);
 
 #### Parameters
 
--   `keyValue` **[number][10]** Device specific key value
+-   `keyValue` **[number][11]** Device specific key value
 
 Returns **[Promise][5]<void>** Appium: support only Android
 
@@ -529,7 +551,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][11]
+[See complete documentation][12]
 
 ```js
 I.makeTouchAction("~buttonStartWebviewCD", 'tap');
@@ -567,14 +589,14 @@ let locator = "#io.selendroid.testapp:id/LinearLayout1";
 I.swipe(locator, 800, 1200, 1000);
 ```
 
-[See complete reference][12]
+[See complete reference][13]
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** 
--   `xoffset` **[number][10]** 
--   `yoffset` **[number][10]** 
--   `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`)
+-   `locator` **([string][4] \| [object][9])** 
+-   `xoffset` **[number][11]** 
+-   `yoffset` **[number][11]** 
+-   `speed` **[number][11]** (optional), 1000 by default (optional, default `1000`)
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -588,8 +610,8 @@ I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
 
 #### Parameters
 
--   `from` **[object][8]** 
--   `to` **[object][8]** Appium: support Android and iOS
+-   `from` **[object][9]** 
+-   `to` **[object][9]** Appium: support Android and iOS
 
 ### swipeDown
 
@@ -604,9 +626,9 @@ I.swipeDown(locator, 1200, 1000); // set offset and speed
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** 
--   `yoffset` **[number][10]?** (optional) (optional, default `1000`)
--   `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`)
+-   `locator` **([string][4] \| [object][9])** 
+-   `yoffset` **[number][11]?** (optional) (optional, default `1000`)
+-   `speed` **[number][11]** (optional), 1000 by default (optional, default `1000`)
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -623,9 +645,9 @@ I.swipeLeft(locator, 1200, 1000); // set offset and speed
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** 
--   `xoffset` **[number][10]?** (optional) (optional, default `1000`)
--   `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`)
+-   `locator` **([string][4] \| [object][9])** 
+-   `xoffset` **[number][11]?** (optional) (optional, default `1000`)
+-   `speed` **[number][11]** (optional), 1000 by default (optional, default `1000`)
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -642,9 +664,9 @@ I.swipeRight(locator, 1200, 1000); // set offset and speed
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** 
--   `xoffset` **[number][10]?** (optional) (optional, default `1000`)
--   `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`)
+-   `locator` **([string][4] \| [object][9])** 
+-   `xoffset` **[number][11]?** (optional) (optional, default `1000`)
+-   `speed` **[number][11]** (optional), 1000 by default (optional, default `1000`)
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -661,9 +683,9 @@ I.swipeUp(locator, 1200, 1000); // set offset and speed
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** 
--   `yoffset` **[number][10]?** (optional) (optional, default `1000`)
--   `speed` **[number][10]** (optional), 1000 by default (optional, default `1000`)
+-   `locator` **([string][4] \| [object][9])** 
+-   `yoffset` **[number][11]?** (optional) (optional, default `1000`)
+-   `speed` **[number][11]** (optional), 1000 by default (optional, default `1000`)
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -686,9 +708,9 @@ I.swipeTo(
 -   `searchableLocator` **[string][4]** 
 -   `scrollLocator` **[string][4]** 
 -   `direction` **[string][4]** 
--   `timeout` **[number][10]** 
--   `offset` **[number][10]** 
--   `speed` **[number][10]** 
+-   `timeout` **[number][11]** 
+-   `offset` **[number][11]** 
+-   `speed` **[number][11]** 
 
 Returns **[Promise][5]<void>** Appium: support Android and iOS
 
@@ -721,7 +743,7 @@ Appium: support Android and iOS
 
 #### Parameters
 
--   `actions` **[Array][6]** Array of touch actions
+-   `actions` **[Array][7]** Array of touch actions
 
 ### pullFile
 
@@ -758,7 +780,7 @@ Perform a rotation gesture centered on the specified element.
 I.rotate(120, 120)
 ```
 
-See corresponding [webdriverio reference][13].
+See corresponding [webdriverio reference][14].
 
 #### Parameters
 
@@ -775,7 +797,7 @@ Returns **[Promise][5]<void>** Appium: support only iOS
 
 Set immediate value in app.
 
-See corresponding [webdriverio reference][14].
+See corresponding [webdriverio reference][15].
 
 #### Parameters
 
@@ -822,7 +844,7 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][4]** text value to append.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
@@ -841,8 +863,8 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][4]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
+-   `field` **([string][4] \| [object][9])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][4]? | [object][9])** (optional, `null` by default) element located by CSS | XPath | strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### click
@@ -871,8 +893,8 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][8] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+-   `locator` **([string][4] \| [object][9])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][4]? | [object][9] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### dontSeeCheckboxIsChecked
@@ -887,7 +909,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeElement
@@ -900,7 +922,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|Strict locator.
+-   `locator` **([string][4] \| [object][9])** located by CSS|XPath|Strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
@@ -915,7 +937,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
@@ -932,7 +954,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 #### Parameters
 
 -   `text` **[string][4]** which is not present.
--   `context` **([string][4] \| [object][8])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+-   `context` **([string][4] \| [object][9])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### fillField
@@ -953,8 +975,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] \| [object][8])** text value to fill.
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator.
+-   `value` **([string][4] \| [object][9])** text value to fill.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### grabTextFromAll
@@ -968,9 +990,9 @@ let pins = await I.grabTextFromAll('#pin li');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][5]<[Array][6]<[string][4]>>** attribute value
+Returns **[Promise][5]<[Array][7]<[string][4]>>** attribute value
 
 ### grabTextFrom
 
@@ -985,7 +1007,7 @@ If multiple elements found returns first element.
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
 
 Returns **[Promise][5]<[string][4]>** attribute value
 
@@ -1000,9 +1022,9 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][5]<[number][10]>** number of visible elements
+Returns **[Promise][5]<[number][11]>** number of visible elements
 
 ### grabAttributeFrom
 
@@ -1018,7 +1040,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
 Returns **[Promise][5]<[string][4]>** attribute value
@@ -1035,10 +1057,10 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][5]<[Array][6]<[string][4]>>** attribute value
+Returns **[Promise][5]<[Array][7]<[string][4]>>** attribute value
 
 ### grabValueFromAll
 
@@ -1051,9 +1073,9 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][5]<[Array][6]<[string][4]>>** attribute value
+Returns **[Promise][5]<[Array][7]<[string][4]>>** attribute value
 
 ### grabValueFrom
 
@@ -1067,7 +1089,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** field located by label|name|CSS|XPath|strict locator.
 
 Returns **[Promise][5]<[string][4]>** attribute value
 
@@ -1098,8 +1120,8 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
--   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][15].
+-   `locator` **([string][4] \| [object][9])** located by CSS|XPath|strict locator.
+-   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][16].
     ⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
 
 ### seeCheckboxIsChecked
@@ -1114,7 +1136,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeElement
@@ -1128,7 +1150,7 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
+-   `locator` **([string][4] \| [object][9])** located by CSS|XPath|strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
@@ -1145,7 +1167,7 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
+-   `field` **([string][4] \| [object][9])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
@@ -1163,7 +1185,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 #### Parameters
 
 -   `text` **[string][4]** expected on page.
--   `context` **([string][4]? | [object][8])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+-   `context` **([string][4]? | [object][9])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### selectOption
@@ -1189,8 +1211,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][4] \| [Array][6]<any>)** visible text or value of option.
+-   `select` **([string][4] \| [object][9])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][4] \| [Array][7]<any>)** visible text or value of option.
     ⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
 
 ### waitForElement
@@ -1205,8 +1227,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### waitForVisible
@@ -1220,8 +1242,8 @@ I.waitForVisible('#popup');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
 
 ### waitForInvisible
@@ -1235,8 +1257,8 @@ I.waitForInvisible('#popup');
 
 #### Parameters
 
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
+-   `locator` **([string][4] \| [object][9])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
 
 ### waitForText
@@ -1253,8 +1275,8 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 #### Parameters
 
 -   `text` **[string][4]** to wait for.
--   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
--   `context` **([string][4] \| [object][8])?** (optional) element located by CSS|XPath|strict locator.
+-   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
+-   `context` **([string][4] \| [object][9])?** (optional) element located by CSS|XPath|strict locator.
     ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 [1]: http://codecept.io/helpers/WebDriver/
@@ -1267,22 +1289,24 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[7]: http://webdriver.io/api/mobile/setNetworkConnection.html
+[8]: http://webdriver.io/api/mobile/setNetworkConnection.html
 
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[9]: https://developer.android.com/reference/android/view/KeyEvent.html
+[10]: https://developer.android.com/reference/android/view/KeyEvent.html
 
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[11]: http://webdriver.io/api/mobile/touchAction.html
+[12]: http://webdriver.io/api/mobile/touchAction.html
 
-[12]: http://webdriver.io/api/mobile/swipe.html
+[13]: http://webdriver.io/api/mobile/swipe.html
 
-[13]: http://webdriver.io/api/mobile/rotate.html
+[14]: http://webdriver.io/api/mobile/rotate.html
 
-[14]: http://webdriver.io/api/mobile/setImmediateValue.html
+[15]: http://webdriver.io/api/mobile/setImmediateValue.html
 
-[15]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
+[16]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView

package/docs/helpers/GraphQL.md

@@ -93,9 +93,9 @@ I.sendMutation(`
 #### Parameters
 
 -   `mutation` **[String][3]** 
--   `variables` **[object][2]** that may go along with the mutation
--   `options` **[object][2]** are additional query options 
--   `headers` **[object][2]**  
+-   `variables` **[object][2]?** that may go along with the mutation
+-   `options` **[object][2]?** are additional query options 
+-   `headers` **[object][2]?**  
 
 Returns **any** Promise<any>
 
@@ -117,9 +117,9 @@ const user = response.data.data;
 #### Parameters
 
 -   `query` **[String][3]** 
--   `variables` **[object][2]** that may go along with the query
--   `options` **[object][2]** are additional query options 
--   `headers` **[object][2]**  
+-   `variables` **[object][2]?** that may go along with the query
+-   `options` **[object][2]?** are additional query options 
+-   `headers` **[object][2]?**  
 
 Returns **any** Promise<any>