Skip to content

Commit bfe8d8f

Browse files
committed
DOC: Autogenerate and update documentation
1 parent e590213 commit bfe8d8f

File tree

7 files changed

+1354
-963
lines changed

7 files changed

+1354
-963
lines changed

docs/helpers/Appium.md

Lines changed: 44 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -886,7 +886,8 @@ I.appendField('password', secret('123456'));
886886

887887
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator
888888
- `value` **[string][5]** text value to append.
889-
⚠️ returns a _promise_ which is synchronized internally by recorder
889+
890+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
890891

891892
### checkOption
892893

@@ -904,8 +905,9 @@ I.checkOption('agree', '//form');
904905
#### Parameters
905906

906907
- `field` **([string][5] \| [object][10])** checkbox located by label | name | CSS | XPath | strict locator.
907-
- `context` **([string][5]? | [object][10])** (optional, `null` by default) element located by CSS | XPath | strict locator.
908-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
908+
- `context` **([string][5]? | [object][10])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`)
909+
910+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
909911

910912
### click
911913

@@ -934,8 +936,9 @@ I.click({css: 'nav a.login'});
934936
#### Parameters
935937

936938
- `locator` **([string][5] \| [object][10])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
937-
- `context` **([string][5]? | [object][10] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
938-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
939+
- `context` **([string][5]? | [object][10] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
940+
941+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
939942

940943
### dontSeeCheckboxIsChecked
941944

@@ -950,7 +953,8 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
950953
#### Parameters
951954

952955
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
953-
⚠️ returns a _promise_ which is synchronized internally by recorder
956+
957+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
954958

955959
### dontSeeElement
956960

@@ -963,7 +967,8 @@ I.dontSeeElement('.modal'); // modal is not shown
963967
#### Parameters
964968

965969
- `locator` **([string][5] \| [object][10])** located by CSS|XPath|Strict locator.
966-
⚠️ returns a _promise_ which is synchronized internally by recorder
970+
971+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
967972

968973
### dontSeeInField
969974

@@ -979,7 +984,8 @@ I.dontSeeInField({ css: 'form input.email' }, '[email protected]'); // field by CSS
979984

980985
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
981986
- `value` **([string][5] \| [object][10])** value to check.
982-
⚠️ returns a _promise_ which is synchronized internally by recorder
987+
988+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
983989

984990
### dontSee
985991

@@ -994,8 +1000,9 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
9941000
#### Parameters
9951001

9961002
- `text` **[string][5]** which is not present.
997-
- `context` **([string][5] \| [object][10])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
998-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
1003+
- `context` **([string][5] \| [object][10])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. (optional, default `null`)
1004+
1005+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
9991006

10001007
### fillField
10011008

@@ -1017,7 +1024,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
10171024

10181025
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
10191026
- `value` **([string][5] \| [object][10])** text value to fill.
1020-
⚠️ returns a _promise_ which is synchronized internally by recorder
1027+
1028+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
10211029

10221030
### grabTextFromAll
10231031

@@ -1162,7 +1170,8 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
11621170

11631171
- `locator` **([string][5] \| [object][10])** located by CSS|XPath|strict locator.
11641172
- `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].
1165-
⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
1173+
1174+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing
11661175

11671176
### seeCheckboxIsChecked
11681177

@@ -1177,7 +1186,8 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
11771186
#### Parameters
11781187

11791188
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
1180-
⚠️ returns a _promise_ which is synchronized internally by recorder
1189+
1190+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
11811191

11821192
### seeElement
11831193

@@ -1191,7 +1201,8 @@ I.seeElement('#modal');
11911201
#### Parameters
11921202

11931203
- `locator` **([string][5] \| [object][10])** located by CSS|XPath|strict locator.
1194-
⚠️ returns a _promise_ which is synchronized internally by recorder
1204+
1205+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
11951206

11961207
### seeInField
11971208

@@ -1209,7 +1220,8 @@ I.seeInField('#searchform input','Search');
12091220

12101221
- `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
12111222
- `value` **([string][5] \| [object][10])** value to check.
1212-
⚠️ returns a _promise_ which is synchronized internally by recorder
1223+
1224+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
12131225

12141226
### see
12151227

@@ -1225,8 +1237,9 @@ I.see('Register', {css: 'form.register'}); // use strict locator
12251237
#### Parameters
12261238

12271239
- `text` **[string][5]** expected on page.
1228-
- `context` **([string][5]? | [object][10])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1229-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
1240+
- `context` **([string][5]? | [object][10])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. (optional, default `null`)
1241+
1242+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
12301243

12311244
### selectOption
12321245

@@ -1253,7 +1266,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
12531266

12541267
- `select` **([string][5] \| [object][10])** field located by label|name|CSS|XPath|strict locator.
12551268
- `option` **([string][5] \| [Array][8]<any>)** visible text or value of option.
1256-
⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
1269+
1270+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing
12571271

12581272
### waitForElement
12591273

@@ -1268,8 +1282,9 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
12681282
#### Parameters
12691283

12701284
- `locator` **([string][5] \| [object][10])** element located by CSS|XPath|strict locator.
1271-
- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait
1272-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
1285+
- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait (optional, default `null`)
1286+
1287+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
12731288

12741289
### waitForVisible
12751290

@@ -1283,8 +1298,9 @@ I.waitForVisible('#popup');
12831298
#### Parameters
12841299

12851300
- `locator` **([string][5] \| [object][10])** element located by CSS|XPath|strict locator.
1286-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1287-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
1301+
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1302+
1303+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
12881304

12891305
### waitForInvisible
12901306

@@ -1298,8 +1314,9 @@ I.waitForInvisible('#popup');
12981314
#### Parameters
12991315

13001316
- `locator` **([string][5] \| [object][10])** element located by CSS|XPath|strict locator.
1301-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1302-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
1317+
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1318+
1319+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
13031320

13041321
### waitForText
13051322

@@ -1316,8 +1333,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
13161333

13171334
- `text` **[string][5]** to wait for.
13181335
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1319-
- `context` **([string][5] \| [object][10])?** (optional) element located by CSS|XPath|strict locator.
1320-
⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
1336+
- `context` **([string][5] \| [object][10])?** (optional) element located by CSS|XPath|strict locator. (optional, default `null`)
1337+
1338+
Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
13211339

13221340
[1]: http://codecept.io/helpers/WebDriver/
13231341

0 commit comments

Comments
 (0)