Skip to content

Commit b9abf5f

Browse files
author
DavertMik
committed
synchronized with docs
1 parent e70c0eb commit b9abf5f

File tree

8 files changed

+1147
-673
lines changed

8 files changed

+1147
-673
lines changed

‎docs/build/Appium.js‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ class Appium extends Webdriver {
10611061
*
10621062
* [See complete reference](http://webdriver.io/api/mobile/swipe.html)
10631063
*
1064-
* @param {CodeceptJS.LocatorOrString} locator
1064+
* @param {string | object} locator
10651065
* @param {number} xoffset
10661066
* @param {number} yoffset
10671067
* @param {number} [speed=1000] (optional), 1000 by default
@@ -1143,7 +1143,7 @@ class Appium extends Webdriver {
11431143
* I.swipeDown(locator, 1200, 1000); // set offset and speed
11441144
* ```
11451145
*
1146-
* @param {CodeceptJS.LocatorOrString} locator
1146+
* @param {string | object} locator
11471147
* @param {number} [yoffset] (optional)
11481148
* @param {number} [speed=1000] (optional), 1000 by default
11491149
* @return {Promise<void>}
@@ -1172,7 +1172,7 @@ class Appium extends Webdriver {
11721172
* I.swipeLeft(locator, 1200, 1000); // set offset and speed
11731173
* ```
11741174
*
1175-
* @param {CodeceptJS.LocatorOrString} locator
1175+
* @param {string | object} locator
11761176
* @param {number} [xoffset] (optional)
11771177
* @param {number} [speed=1000] (optional), 1000 by default
11781178
* @return {Promise<void>}
@@ -1199,7 +1199,7 @@ class Appium extends Webdriver {
11991199
* I.swipeRight(locator, 1200, 1000); // set offset and speed
12001200
* ```
12011201
*
1202-
* @param {CodeceptJS.LocatorOrString} locator
1202+
* @param {string | object} locator
12031203
* @param {number} [xoffset] (optional)
12041204
* @param {number} [speed=1000] (optional), 1000 by default
12051205
* @return {Promise<void>}
@@ -1226,7 +1226,7 @@ class Appium extends Webdriver {
12261226
* I.swipeUp(locator, 1200, 1000); // set offset and speed
12271227
* ```
12281228
*
1229-
* @param {CodeceptJS.LocatorOrString} locator
1229+
* @param {string | object} locator
12301230
* @param {number} [yoffset] (optional)
12311231
* @param {number} [speed=1000] (optional), 1000 by default
12321232
* @return {Promise<void>}
@@ -1480,7 +1480,7 @@ class Appium extends Webdriver {
14801480
* // typing secret
14811481
* I.appendField('password', secret('123456'));
14821482
* ```
1483-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
1483+
* @param {string | object} field located by label|name|CSS|XPath|strict locator
14841484
* @param {string} value text value to append.
14851485
* @returns {void} automatically synchronized promise through #recorder
14861486
*
@@ -1502,8 +1502,8 @@ class Appium extends Webdriver {
15021502
* I.checkOption('I Agree to Terms and Conditions');
15031503
* I.checkOption('agree', '//form');
15041504
* ```
1505-
* @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
1506-
* @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
1505+
* @param {string | object} field checkbox located by label | name | CSS | XPath | strict locator.
1506+
* @param {?string | object} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
15071507
* @returns {void} automatically synchronized promise through #recorder
15081508
*
15091509
*
@@ -1536,8 +1536,8 @@ class Appium extends Webdriver {
15361536
* I.click({css: 'nav a.login'});
15371537
* ```
15381538
*
1539-
* @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1540-
* @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1539+
* @param {string | object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1540+
* @param {?string | object | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
15411541
* @returns {void} automatically synchronized promise through #recorder
15421542
*
15431543
*
@@ -1563,7 +1563,7 @@ class Appium extends Webdriver {
15631563
* I.dontSeeCheckboxIsChecked('agree'); // located by name
15641564
* ```
15651565
*
1566-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1566+
* @param {string | object} field located by label|name|CSS|XPath|strict locator.
15671567
* @returns {void} automatically synchronized promise through #recorder
15681568
*
15691569
*
@@ -1580,7 +1580,7 @@ class Appium extends Webdriver {
15801580
* I.dontSeeElement('.modal'); // modal is not shown
15811581
* ```
15821582
*
1583-
* @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
1583+
* @param {string | object} locator located by CSS|XPath|Strict locator.
15841584
* @returns {void} automatically synchronized promise through #recorder
15851585
*
15861586
*/
@@ -1598,8 +1598,8 @@ class Appium extends Webdriver {
15981598
* I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
15991599
* ```
16001600
*
1601-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1602-
* @param {CodeceptJS.StringOrSecret} value value to check.
1601+
* @param {string | object} field located by label|name|CSS|XPath|strict locator.
1602+
* @param {string | object} value value to check.
16031603
* @returns {void} automatically synchronized promise through #recorder
16041604
*
16051605
*
@@ -1620,7 +1620,7 @@ class Appium extends Webdriver {
16201620
* ```
16211621
*
16221622
* @param {string} text which is not present.
1623-
* @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
1623+
* @param {string | object} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
16241624
* @returns {void} automatically synchronized promise through #recorder
16251625
*
16261626
*/
@@ -1643,8 +1643,8 @@ class Appium extends Webdriver {
16431643
* // or by strict locator
16441644
* I.fillField({css: 'form#login input[name=username]'}, 'John');
16451645
* ```
1646-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1647-
* @param {CodeceptJS.StringOrSecret} value text value to fill.
1646+
* @param {string | object} field located by label|name|CSS|XPath|strict locator.
1647+
* @param {string | object} value text value to fill.
16481648
* @returns {void} automatically synchronized promise through #recorder
16491649
*
16501650
*
@@ -1663,7 +1663,7 @@ class Appium extends Webdriver {
16631663
* let pins = await I.grabTextFromAll('#pin li');
16641664
* ```
16651665
*
1666-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1666+
* @param {string | object} locator element located by CSS|XPath|strict locator.
16671667
* @returns {Promise<string[]>} attribute value
16681668
*
16691669
*
@@ -1682,7 +1682,7 @@ class Appium extends Webdriver {
16821682
* ```
16831683
* If multiple elements found returns first element.
16841684
*
1685-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1685+
* @param {string | object} locator element located by CSS|XPath|strict locator.
16861686
* @returns {Promise<string>} attribute value
16871687
*
16881688
*
@@ -1700,7 +1700,7 @@ class Appium extends Webdriver {
17001700
* let numOfElements = await I.grabNumberOfVisibleElements('p');
17011701
* ```
17021702
*
1703-
* @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1703+
* @param {string | object} locator located by CSS|XPath|strict locator.
17041704
* @returns {Promise<number>} number of visible elements
17051705
*/
17061706
async grabNumberOfVisibleElements(locator) {
@@ -1718,7 +1718,7 @@ class Appium extends Webdriver {
17181718
* ```js
17191719
* let hint = await I.grabAttributeFrom('#tooltip', 'title');
17201720
* ```
1721-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1721+
* @param {string | object} locator element located by CSS|XPath|strict locator.
17221722
* @param {string} attr attribute name.
17231723
* @returns {Promise<string>} attribute value
17241724
*
@@ -1736,7 +1736,7 @@ class Appium extends Webdriver {
17361736
* ```js
17371737
* let hints = await I.grabAttributeFromAll('.tooltip', 'title');
17381738
* ```
1739-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1739+
* @param {string | object} locator element located by CSS|XPath|strict locator.
17401740
* @param {string} attr attribute name.
17411741
* @returns {Promise<string[]>} attribute value
17421742
*
@@ -1753,7 +1753,7 @@ class Appium extends Webdriver {
17531753
* ```js
17541754
* let inputs = await I.grabValueFromAll('//form/input');
17551755
* ```
1756-
* @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
1756+
* @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
17571757
* @returns {Promise<string[]>} attribute value
17581758
*
17591759
*
@@ -1771,7 +1771,7 @@ class Appium extends Webdriver {
17711771
* ```js
17721772
* let email = await I.grabValueFrom('input[name=email]');
17731773
* ```
1774-
* @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
1774+
* @param {string | object} locator field located by label|name|CSS|XPath|strict locator.
17751775
* @returns {Promise<string>} attribute value
17761776
*
17771777
*
@@ -1805,7 +1805,7 @@ class Appium extends Webdriver {
18051805
* I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
18061806
* ```
18071807
*
1808-
* @param {LocatorOrString} locator located by CSS|XPath|strict locator.
1808+
* @param {string | object} locator located by CSS|XPath|strict locator.
18091809
* @param {ScrollIntoViewOptions|boolean} scrollIntoViewOptions either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
18101810
* @returns {void} automatically synchronized promise through #recorder
18111811
*
@@ -1825,7 +1825,7 @@ class Appium extends Webdriver {
18251825
* I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
18261826
* ```
18271827
*
1828-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1828+
* @param {string | object} field located by label|name|CSS|XPath|strict locator.
18291829
* @returns {void} automatically synchronized promise through #recorder
18301830
*
18311831
*
@@ -1842,7 +1842,7 @@ class Appium extends Webdriver {
18421842
* ```js
18431843
* I.seeElement('#modal');
18441844
* ```
1845-
* @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1845+
* @param {string | object} locator located by CSS|XPath|strict locator.
18461846
* @returns {void} automatically synchronized promise through #recorder
18471847
*
18481848
*
@@ -1862,8 +1862,8 @@ class Appium extends Webdriver {
18621862
* I.seeInField('form input[type=hidden]','hidden_value');
18631863
* I.seeInField('#searchform input','Search');
18641864
* ```
1865-
* @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1866-
* @param {CodeceptJS.StringOrSecret} value value to check.
1865+
* @param {string | object} field located by label|name|CSS|XPath|strict locator.
1866+
* @param {string | object} value value to check.
18671867
* @returns {void} automatically synchronized promise through #recorder
18681868
*
18691869
*
@@ -1884,7 +1884,7 @@ class Appium extends Webdriver {
18841884
* I.see('Register', {css: 'form.register'}); // use strict locator
18851885
* ```
18861886
* @param {string} text expected on page.
1887-
* @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1887+
* @param {?string | object} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
18881888
* @returns {void} automatically synchronized promise through #recorder
18891889
*
18901890
*
@@ -1913,7 +1913,7 @@ class Appium extends Webdriver {
19131913
* ```js
19141914
* I.selectOption('Which OS do you use?', ['Android', 'iOS']);
19151915
* ```
1916-
* @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
1916+
* @param {string | object} select field located by label|name|CSS|XPath|strict locator.
19171917
* @param {string|Array<*>} option visible text or value of option.
19181918
* @returns {void} automatically synchronized promise through #recorder
19191919
*
@@ -1934,7 +1934,7 @@ class Appium extends Webdriver {
19341934
* I.waitForElement('.btn.continue', 5); // wait for 5 secs
19351935
* ```
19361936
*
1937-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1937+
* @param {string | object} locator element located by CSS|XPath|strict locator.
19381938
* @param {number} [sec] (optional, `1` by default) time in seconds to wait
19391939
* @returns {void} automatically synchronized promise through #recorder
19401940
*
@@ -1953,7 +1953,7 @@ class Appium extends Webdriver {
19531953
* I.waitForVisible('#popup');
19541954
* ```
19551955
*
1956-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1956+
* @param {string | object} locator element located by CSS|XPath|strict locator.
19571957
* @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
19581958
* @returns {void} automatically synchronized promise through #recorder
19591959
*
@@ -1972,7 +1972,7 @@ class Appium extends Webdriver {
19721972
* I.waitForInvisible('#popup');
19731973
* ```
19741974
*
1975-
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1975+
* @param {string | object} locator element located by CSS|XPath|strict locator.
19761976
* @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
19771977
* @returns {void} automatically synchronized promise through #recorder
19781978
*
@@ -1995,7 +1995,7 @@ class Appium extends Webdriver {
19951995
*
19961996
* @param {string }text to wait for.
19971997
* @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
1998-
* @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
1998+
* @param {string | object} [context] (optional) element located by CSS|XPath|strict locator.
19991999
* @returns {void} automatically synchronized promise through #recorder
20002000
*
20012001
*

0 commit comments

Comments
 (0)