codeceptjs 3.3.2 → 3.3.5-beta.1

package/docs/helpers/Appium.md

@@ -1255,719 +1255,6 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `context` **([string][4] \| [object][8])?** (optional) element located by CSS|XPath|strict locator.
     [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
-### useWebDriverTo
-
-Use [webdriverio][16] API inside a test.
-
-First argument is a description of an action.
-Second argument is async function that gets this helper as parameter.
-
-{ [`browser`][16]) } object from WebDriver API is available.
-
-```js
-I.useWebDriverTo('open multiple windows', async ({ browser }) {
-   // create new window
-   await browser.newWindow('https://webdriver.io');
-});
-```
-
-#### Parameters
-
--   `description` **[string][4]** used to show in logs.
--   `fn` **[function][17]** async functuion that executed with WebDriver helper as argument
-
-### \_isShadowLocator
-
-Check if locator is type of "Shadow"
-
-#### Parameters
-
--   `locator` **[object][8]** 
-
-### \_locateShadow
-
-Locate Element within the Shadow Dom
-
-#### Parameters
-
--   `locator` **[object][8]** 
-
-### \_smartWait
-
-Smart Wait to locate an element
-
-#### Parameters
-
--   `locator` **[object][8]** 
-
-### \_locate
-
-Get elements by different locator types, including strict locator.
-Should be used in custom helpers:
-
-```js
-this.helpers['WebDriver']._locate({name: 'password'}).then //...
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `smartWait`   (optional, default `false`)
-
-### \_locateCheckable
-
-Find a checkbox by providing human readable text:
-
-```js
-this.helpers['WebDriver']._locateCheckable('I agree with terms and conditions').then // ...
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
-
-### \_locateClickable
-
-Find a clickable element by providing human readable text:
-
-```js
-const els = await this.helpers.WebDriver._locateClickable('Next page');
-const els = await this.helpers.WebDriver._locateClickable('Next page', '.pages');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `context`  
-
-### \_locateFields
-
-Find field elements by providing human readable text:
-
-```js
-this.helpers['WebDriver']._locateFields('Your email').then // ...
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
-
-### defineTimeout
-
-Set [WebDriver timeouts][18] in realtime.
-
-Timeouts are expected to be passed as object:
-
-```js
-I.defineTimeout({ script: 5000 });
-I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
-```
-
-#### Parameters
-
--   `timeouts` **any** WebDriver timeouts object.
-
-### amOnPage
-
-Opens a web page in a browser. Requires relative or absolute url.
-If url starts with `/`, opens a web page of a site defined in `url` config parameter.
-
-```js
-I.amOnPage('/'); // opens main page of website
-I.amOnPage('https://github.com'); // opens github
-I.amOnPage('/login'); // opens a login page
-```
-
-#### Parameters
-
--   `url` **[string][4]** url path or global url.
-
-Returns **void** automatically synchronized promise with recorder #!
-
-### forceClick
-
-Perform an emulated click on a link or a button, given by a locator.
-Unlike normal click instead of sending native event, emulates a click with JavaScript.
-This works on hidden, animated or inactive elements as well.
-
-If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
-For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
-For images, the "alt" attribute and inner text of any parent links are searched.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-// simple link
-I.forceClick('Logout');
-// button of form
-I.forceClick('Submit');
-// CSS button
-I.forceClick('#form input[type=submit]');
-// XPath
-I.forceClick('//form/*[@type=submit]');
-// link in context
-I.forceClick('Logout', '#nav');
-// using strict locator
-I.forceClick({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])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder{{ react }} (optional, default `null`)
-
-### doubleClick
-
-Performs a double-click on an element matched by link|button|label|CSS or XPath.
-Context can be specified as second parameter to narrow search.
-
-```js
-I.doubleClick('Edit');
-I.doubleClick('Edit', '.actions');
-I.doubleClick({css: 'button.accept'});
-I.doubleClick('.btn.edit');
-```
-
-#### 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])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder{{ react }} (optional, default `null`)
-
-### rightClick
-
-Performs right click on a clickable element matched by semantic locator, CSS or XPath.
-
-```js
-// right click element with id el
-I.rightClick('#el');
-// right click link or button with text "Click me"
-I.rightClick('Click me');
-// right click button with text "Click me" inside .context
-I.rightClick('Click me', '.context');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder{{ react }} (optional, default `null`)
-
-### forceRightClick
-
-Emulates right click on an element.
-Unlike normal click instead of sending native event, emulates a click with JavaScript.
-This works on hidden, animated or inactive elements as well.
-
-If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
-For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
-For images, the "alt" attribute and inner text of any parent links are searched.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-// simple link
-I.forceRightClick('Menu');
-```
-
-#### 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])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder{{ react }} (optional, default `null`)
-
-### clearField
-
-Clears a `<textarea>` or text `<input>` element's value.
-
-```js
-I.clearField('Email');
-I.clearField('user[email]');
-I.clearField('#email');
-```
-
-#### Parameters
-
--   `field`  
--   `editable` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### attachFile
-
-Attaches a file to element located by label, name, CSS or XPath
-Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
-File will be uploaded to remote system (if tests are running remotely).
-
-```js
-I.attachFile('Avatar', 'data/avatar.jpg');
-I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` **[string][4]** local file path relative to codecept.json config file.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    Appium: not tested
-
-### 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][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.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    Appium: not tested (optional, default `null`)
-
-### grabHTMLFromAll
-
-Retrieves all the innerHTML from elements located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let postHTMLs = await I.grabHTMLFromAll('.post');
-```
-
-#### Parameters
-
--   `locator`  
--   `element` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][5]&lt;[Array][6]&lt;[string][4]>>** HTML code for an element
-
-### 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.
-If more than one element is found - HTML of first element is returned.
-
-```js
-let postHTML = await I.grabHTMLFrom('#post');
-```
-
-#### Parameters
-
--   `locator`  
--   `element` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][5]&lt;[string][4]>** HTML code for an element
-
-### seeTextEquals
-
-Checks that text is equal to provided one.
-
-```js
-I.seeTextEquals('text', 'h1');
-```
-
-#### Parameters
-
--   `text` **[string][4]** element value to check.
--   `context` **([string][4] \| [object][8])?** element located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
-
-### seeElementInDOM
-
-Checks that a given Element is present in the DOM
-Element is located by CSS or XPath.
-
-```js
-I.seeElementInDOM('#modal');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### 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` **([string][4] \| [object][8])** located by CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### seeInSource
-
-Checks that the current page contains the given string in its raw source code.
-
-```js
-I.seeInSource('<h1>Green eggs &amp; ham</h1>');
-```
-
-#### Parameters
-
--   `text` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### grabSource
-
-Retrieves page source and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let pageSource = await I.grabSource();
-```
-
-Returns **[Promise][5]&lt;[string][4]>** source code
-
-### 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.
-
-```js
-let logs = await I.grabBrowserLogs();
-console.log(JSON.stringify(logs))
-```
-
-Returns **([Promise][5]&lt;[Array][6]&lt;[object][8]>> | [undefined][19])** all browser logs
-
-### 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` **[string][4]** to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### seeNumberOfElements
-
-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
-I.seeNumberOfElements('#submitBtn', 1);
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `num` **[number][10]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    {{ react }}
-
-### seeNumberOfVisibleElements
-
-Asserts that an element is visible a given number of times.
-Element is located by CSS or XPath.
-
-```js
-I.seeNumberOfVisibleElements('.buttons', 3);
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `num` **[number][10]** number of elements.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    {{ react }}
-
-### seeAttributesOnElements
-
-Checks that all elements with given locator have given attributes.
-
-```js
-I.seeAttributesOnElements('//form', { method: "post"});
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
--   `attributes` **[object][8]** attributes and their values to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### scrollTo
-
-Scrolls to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-```js
-I.scrollTo('footer');
-I.scrollTo('#submit', 5, 5);
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. (optional, default `0`)
--   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `0`)
-
-### moveCursorTo
-
-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);
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
--   `xOffset`  
--   `yOffset`  
--   `offsetX` **[number][10]** (optional, `0` by default) X-axis offset. (optional, default `0`)
--   `offsetY` **[number][10]** (optional, `0` by default) Y-axis offset.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `0`)
-
-### saveElementScreenshot
-
-Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder.
-
-```js
-I.saveElementScreenshot(`#submit`,'debug.png');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `fileName` **[string][4]** file name to save.
-    [!] returns a _promise_ which is synchronized internally by recorder
-
-### type
-
-Types out the given text into an active field.
-To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][20] is not an option.
-
-```js
-// passing in a string
-I.type('Type this out.');
-
-// typing values with a 100ms interval
-I.type('4141555311111111', 100);
-
-// passing in an array
-I.type(['T', 'E', 'X', 'T']);
-```
-
-#### Parameters
-
--   `keys`  
--   `delay` **[number][10]?** (optional) delay in ms between key presses
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
--   `key` **([string][4] \| [Array][6]&lt;[string][4]>)** or array of keys to type.
-
-### dragAndDrop
-
-Drag an item to a destination element.
-
-```js
-I.dragAndDrop('#dragHandle', '#container');
-```
-
-#### Parameters
-
--   `srcElement` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
--   `destElement` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
-    Appium: not tested
-
-### dragSlider
-
-Drag the scrubber of a slider to a given position
-For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
-
-```js
-I.dragSlider('#slider', 30);
-I.dragSlider('#slider', -70);
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
--   `offsetX` **[number][10]** position to drag.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `0`)
-
-### grabAllWindowHandles
-
-Get all Window Handles.
-Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
-
-```js
-const windows = await I.grabAllWindowHandles();
-```
-
-Returns **[Promise][5]&lt;[Array][6]&lt;[string][4]>>** 
-
-### grabCurrentWindowHandle
-
-Get the current Window Handle.
-Useful for referencing it when calling `I.switchToWindow(handle)`
-
-```js
-const window = await I.grabCurrentWindowHandle();
-```
-
-Returns **[Promise][5]&lt;[string][4]>** 
-
-### switchToWindow
-
-Switch to the window with a specified handle.
-
-```js
-const windows = await I.grabAllWindowHandles();
-// ... do something
-await I.switchToWindow( windows[0] );
-
-const window = await I.grabCurrentWindowHandle();
-// ... do something
-await I.switchToWindow( window );
-```
-
-#### Parameters
-
--   `window` **[string][4]** name of window handle.
-
-### closeOtherTabs
-
-Close all tabs except for the current one.
-
-```js
-I.closeOtherTabs();
-```
-
-[!] returns a _promise_ which is synchronized internally by recorder
-
-### 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` **([string][4]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
-
-### grabNumberOfOpenTabs
-
-Grab number of open tabs.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let tabs = await I.grabNumberOfOpenTabs();
-```
-
-Returns **[Promise][5]&lt;[number][10]>** number of open tabs
-
-### scrollPageToTop
-
-Scroll page to the top.
-
-```js
-I.scrollPageToTop();
-```
-
-[!] returns a _promise_ which is synchronized internally by recorder
-
-### scrollPageToBottom
-
-Scroll page to the bottom.
-
-```js
-I.scrollPageToBottom();
-```
-
-[!] returns a _promise_ which is synchronized internally by recorder
-
-### 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.
-
-```js
-let { x, y } = await I.grabPageScrollPosition();
-```
-
-Returns **[Promise][5]&lt;PageScrollPosition>** scroll position
-
-### setGeoLocation
-
-Set the current geo location
-
-```js
-I.setGeoLocation(121.21, 11.56);
-I.setGeoLocation(121.21, 11.56, 10);
-```
-
-#### Parameters
-
--   `latitude` **[number][10]** to set.
--   `longitude` **[number][10]** to set
--   `altitude` **[number][10]?** (optional, null by default) to set
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
-
-### grabGeoLocation
-
-Return the current geo location 
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let geoLocation = await I.grabGeoLocation();
-```
-
-Returns **[Promise][5]&lt;{latitude: [number][10], longitude: [number][10], altitude: [number][10]}>** 
-
-### grabElementBoundingRect
-
-Grab the width, height, location of given locator.
-Provide `width` or `height`as second param to get your desired prop.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-Returns an object with `x`, `y`, `width`, `height` keys.
-
-```js
-const value = await I.grabElementBoundingRect('h3');
-// value is like { x: 226.5, y: 89, width: 527, height: 220 }
-```
-
-To get only one metric use second parameter:
-
-```js
-const width = await I.grabElementBoundingRect('h3', 'width');
-// width == 527
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
--   `prop`  
--   `elementSize` **[string][4]?** x, y, width or height of the given element.
-
-Returns **([Promise][5]&lt;DOMRect> | [Promise][5]&lt;[number][10]>)** Element bounding rectangle
-
 [1]: http://codecept.io/helpers/WebDriver/
 
 [2]: http://appium.io/
@@ -1997,13 +1284,3 @@ Returns **([Promise][5]&lt;DOMRect> | [Promise][5]&lt;[number][10]>)** Element b
 [14]: http://webdriver.io/api/mobile/setImmediateValue.html
 
 [15]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
-
-[16]: https://webdriver.io/docs/api.html
-
-[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[18]: https://webdriver.io/docs/timeouts.html
-
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
-
-[20]: #fillfield