codeceptjs 4.2.2 → 4.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/docs/ai.md +1 -1
- package/docs/alternative-browsers.md +4 -4
- package/docs/api.md +13 -13
- package/docs/assertions.md +6 -6
- package/docs/best.md +1 -1
- package/docs/bootstrap.md +1 -1
- package/docs/data.md +8 -8
- package/docs/element-selection.md +27 -4
- package/docs/helpers/ApiDataFactory.md +2 -2
- package/docs/helpers/Appium.md +56 -56
- package/docs/helpers/Decision.md +1 -1
- package/docs/helpers/Detox.md +1 -1
- package/docs/helpers/ExpectHelper.md +1 -1
- package/docs/helpers/FileSystem.md +1 -1
- package/docs/helpers/GraphQL.md +1 -1
- package/docs/helpers/GraphQLDataFactory.md +2 -2
- package/docs/helpers/JSONResponse.md +1 -1
- package/docs/helpers/Kitesurf.md +65 -65
- package/docs/helpers/Lightpanda.md +65 -65
- package/docs/helpers/MockRequest.md +1 -1
- package/docs/helpers/Moli.md +65 -65
- package/docs/helpers/Obscura.md +65 -65
- package/docs/helpers/Playwright.md +127 -127
- package/docs/helpers/Puppeteer.md +88 -88
- package/docs/helpers/REST.md +1 -1
- package/docs/helpers/WebDriver.md +87 -87
- package/docs/installation.md +1 -1
- package/docs/locators.md +5 -7
- package/docs/migration-4.md +7 -3
- package/docs/mobile.md +2 -2
- package/docs/parallel.md +1 -1
- package/docs/playwright.md +5 -5
- package/docs/plugins/aiTrace.md +1 -1
- package/docs/plugins/autoDelay.md +1 -1
- package/docs/plugins/customLocator.md +1 -1
- package/docs/plugins/customReporter.md +1 -1
- package/docs/plugins/junitReporter.md +2 -2
- package/docs/plugins/pageInfo.md +1 -1
- package/docs/plugins/pauseOnFail.md +1 -1
- package/docs/plugins/retryFailedStep.md +1 -1
- package/docs/plugins/screenshotOnFail.md +1 -1
- package/docs/plugins/stepTimeout.md +1 -1
- package/docs/plugins.md +10 -10
- package/docs/puppeteer.md +4 -4
- package/docs/retry.md +1 -1
- package/docs/timeouts.md +7 -7
- package/docs/webdriver.md +8 -8
- package/lib/actor.js +20 -2
- package/lib/aria.js +1 -0
- package/lib/codecept.js +1 -1
- package/lib/data/context.js +24 -0
- package/lib/element/WebElement.js +5 -5
- package/lib/helper/ApiDataFactory.js +1 -1
- package/lib/helper/Appium.js +2 -2
- package/lib/helper/GraphQLDataFactory.js +1 -1
- package/lib/helper/Playwright.js +22 -12
- package/lib/helper/Puppeteer.js +5 -11
- package/lib/mocha/asyncWrapper.js +14 -3
- package/lib/mocha/test.js +1 -0
- package/lib/plugin/auth.js +3 -0
- package/lib/plugin/junitReporter.js +21 -12
- package/lib/recorder.js +22 -3
- package/lib/step/base.js +8 -1
- package/lib/step/func.js +1 -1
- package/lib/step/helper.js +1 -1
- package/lib/step/record.js +22 -17
- package/lib/step/retry.js +13 -6
- package/lib/utils/typescript.js +86 -12
- package/lib/workers.js +15 -0
- package/package.json +2 -1
- package/typings/index.d.ts +12 -0
- package/typings/promiseBasedTypes.d.ts +696 -351
- package/typings/types.d.ts +485 -352
package/docs/helpers/Moli.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
permalink: /helpers/
|
|
2
|
+
permalink: /helpers/moli
|
|
3
3
|
editLink: false
|
|
4
4
|
sidebar: auto
|
|
5
5
|
title: Moli
|
|
@@ -142,7 +142,7 @@ I.amOnPage('/login'); // opens a login page
|
|
|
142
142
|
|
|
143
143
|
* `url` **[string][3]** url path or global url.
|
|
144
144
|
|
|
145
|
-
Returns **
|
|
145
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
146
146
|
|
|
147
147
|
### appendField
|
|
148
148
|
|
|
@@ -165,7 +165,7 @@ I.appendField('name', 'John', '.form-container');
|
|
|
165
165
|
* `value` **[string][3]** text value to append.
|
|
166
166
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
167
167
|
|
|
168
|
-
Returns **
|
|
168
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
169
169
|
|
|
170
170
|
### attachFile
|
|
171
171
|
|
|
@@ -196,7 +196,7 @@ I.attachFile('#dropzone', 'data/avatar.jpg');
|
|
|
196
196
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
197
197
|
* `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
|
|
198
198
|
|
|
199
|
-
Returns **
|
|
199
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
200
200
|
|
|
201
201
|
### blur
|
|
202
202
|
|
|
@@ -221,7 +221,7 @@ I.dontSee('#add-to-cart-btn');
|
|
|
221
221
|
* `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
|
|
222
222
|
* `options` **any?** Playwright only: [Additional options][6] for available options object as 2nd argument.
|
|
223
223
|
|
|
224
|
-
Returns **
|
|
224
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
225
225
|
|
|
226
226
|
### capabilities
|
|
227
227
|
|
|
@@ -245,7 +245,7 @@ I.checkOption('agree', '//form');
|
|
|
245
245
|
* `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
|
|
246
246
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
247
247
|
|
|
248
|
-
Returns **
|
|
248
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
249
249
|
|
|
250
250
|
### clearClipboard
|
|
251
251
|
|
|
@@ -256,7 +256,7 @@ I.clearClipboard();
|
|
|
256
256
|
I.seeClipboardEquals('');
|
|
257
257
|
```
|
|
258
258
|
|
|
259
|
-
Returns **
|
|
259
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
260
260
|
|
|
261
261
|
### clearCookie
|
|
262
262
|
|
|
@@ -293,7 +293,7 @@ I.clearField('Email', '.form-container');
|
|
|
293
293
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
294
294
|
* `editable` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
|
|
295
295
|
|
|
296
|
-
Returns **
|
|
296
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder.
|
|
297
297
|
|
|
298
298
|
### click
|
|
299
299
|
|
|
@@ -332,7 +332,7 @@ I.click({role: 'button', name: 'Submit'});
|
|
|
332
332
|
* `locator` **([string][3] | [object][4])** (optional, `'//body'` by default) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
333
333
|
* `context` **([string][3]? | [object][4] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
334
334
|
|
|
335
|
-
Returns **
|
|
335
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
336
336
|
|
|
337
337
|
### clickXY
|
|
338
338
|
|
|
@@ -367,7 +367,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
|
|
|
367
367
|
* `text` **[string][3]** which is not present.
|
|
368
368
|
* `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
369
369
|
|
|
370
|
-
Returns **
|
|
370
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
371
371
|
|
|
372
372
|
### dontSeeCheckboxIsChecked
|
|
373
373
|
|
|
@@ -384,7 +384,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
|
|
|
384
384
|
* `locator`  
|
|
385
385
|
* `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
|
|
386
386
|
|
|
387
|
-
Returns **
|
|
387
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
388
388
|
|
|
389
389
|
### dontSeeCookie
|
|
390
390
|
|
|
@@ -398,7 +398,7 @@ I.dontSeeCookie('auth'); // no auth cookie
|
|
|
398
398
|
|
|
399
399
|
* `name` **[string][3]** cookie name.
|
|
400
400
|
|
|
401
|
-
Returns **
|
|
401
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
402
402
|
|
|
403
403
|
### dontSeeCurrentPathEquals
|
|
404
404
|
|
|
@@ -414,7 +414,7 @@ I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
|
|
|
414
414
|
|
|
415
415
|
* `path` **[string][3]** value to check.
|
|
416
416
|
|
|
417
|
-
Returns **
|
|
417
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
418
418
|
|
|
419
419
|
### dontSeeCurrentUrlEquals
|
|
420
420
|
|
|
@@ -430,7 +430,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
|
|
|
430
430
|
|
|
431
431
|
* `url` **[string][3]** value to check.
|
|
432
432
|
|
|
433
|
-
Returns **
|
|
433
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
434
434
|
|
|
435
435
|
### dontSeeElement
|
|
436
436
|
|
|
@@ -448,7 +448,7 @@ I.dontSeeElement('.modal', '#container');
|
|
|
448
448
|
* `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
|
|
449
449
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
450
450
|
|
|
451
|
-
Returns **
|
|
451
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
452
452
|
|
|
453
453
|
### dontSeeElementInDOM
|
|
454
454
|
|
|
@@ -462,7 +462,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
|
|
|
462
462
|
|
|
463
463
|
* `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
|
|
464
464
|
|
|
465
|
-
Returns **
|
|
465
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
466
466
|
|
|
467
467
|
### dontSeeInCurrentUrl
|
|
468
468
|
|
|
@@ -472,7 +472,7 @@ Checks that current url does not contain a provided fragment.
|
|
|
472
472
|
|
|
473
473
|
* `url` **[string][3]** value to check.
|
|
474
474
|
|
|
475
|
-
Returns **
|
|
475
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
476
476
|
|
|
477
477
|
### dontSeeInField
|
|
478
478
|
|
|
@@ -494,7 +494,7 @@ I.dontSeeInField('Name', 'old_value', '.form-container');
|
|
|
494
494
|
* `value` **([string][3] | [object][4])** value to check.
|
|
495
495
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
496
496
|
|
|
497
|
-
Returns **
|
|
497
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
498
498
|
|
|
499
499
|
### dontSeeInSource
|
|
500
500
|
|
|
@@ -509,7 +509,7 @@ I.dontSeeInSource('<!--'); // no comments in source
|
|
|
509
509
|
* `text`  
|
|
510
510
|
* `value` **[string][3]** to check.
|
|
511
511
|
|
|
512
|
-
Returns **
|
|
512
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
513
513
|
|
|
514
514
|
### dontSeeInTitle
|
|
515
515
|
|
|
@@ -523,7 +523,7 @@ I.dontSeeInTitle('Error');
|
|
|
523
523
|
|
|
524
524
|
* `text` **[string][3]** value to check.
|
|
525
525
|
|
|
526
|
-
Returns **
|
|
526
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
527
527
|
|
|
528
528
|
### dontSeeTraffic
|
|
529
529
|
|
|
@@ -562,7 +562,7 @@ I.doubleClick('.btn.edit');
|
|
|
562
562
|
* `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
563
563
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
564
564
|
|
|
565
|
-
Returns **
|
|
565
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
566
566
|
|
|
567
567
|
### executeAsyncScript
|
|
568
568
|
|
|
@@ -657,7 +657,7 @@ I.fillField('Name', 'John', '#section2');
|
|
|
657
657
|
* `value` **([string][3] | [object][4])** text value to fill.
|
|
658
658
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
659
659
|
|
|
660
|
-
Returns **
|
|
660
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
661
661
|
|
|
662
662
|
### flushNetworkTraffics
|
|
663
663
|
|
|
@@ -684,7 +684,7 @@ I.see('#add-to-cart-bnt');
|
|
|
684
684
|
* `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
|
|
685
685
|
* `options` **any?** Playwright only: [Additional options][13] for available options object as 2nd argument.
|
|
686
686
|
|
|
687
|
-
Returns **
|
|
687
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
688
688
|
|
|
689
689
|
### forceClick
|
|
690
690
|
|
|
@@ -718,7 +718,7 @@ I.forceClick({css: 'nav a.login'});
|
|
|
718
718
|
* `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
719
719
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
720
720
|
|
|
721
|
-
Returns **
|
|
721
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
722
722
|
|
|
723
723
|
### grabAriaSnapshot
|
|
724
724
|
|
|
@@ -1042,7 +1042,7 @@ const webElement = await I.grabWebElement('#button');
|
|
|
1042
1042
|
|
|
1043
1043
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1044
1044
|
|
|
1045
|
-
Returns **[Promise][12]<
|
|
1045
|
+
Returns **[Promise][12]<CodeceptJS.WebElement>** WebElement of being used Web helper
|
|
1046
1046
|
|
|
1047
1047
|
### grabWebElements
|
|
1048
1048
|
|
|
@@ -1057,7 +1057,7 @@ const webElements = await I.grabWebElements('#button');
|
|
|
1057
1057
|
|
|
1058
1058
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1059
1059
|
|
|
1060
|
-
Returns **[Promise][12]<
|
|
1060
|
+
Returns **[Promise][12]<[Array][15]<CodeceptJS.WebElement>>** WebElements of being used Web helper
|
|
1061
1061
|
|
|
1062
1062
|
### pressKey
|
|
1063
1063
|
|
|
@@ -1082,7 +1082,7 @@ Reload the current page.
|
|
|
1082
1082
|
I.refreshPage();
|
|
1083
1083
|
```
|
|
1084
1084
|
|
|
1085
|
-
Returns **
|
|
1085
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1086
1086
|
|
|
1087
1087
|
### resizeWindow
|
|
1088
1088
|
|
|
@@ -1094,7 +1094,7 @@ First parameter can be set to `maximize`.
|
|
|
1094
1094
|
* `width` **[number][8]** width in pixels or `maximize`.
|
|
1095
1095
|
* `height` **[number][8]** height in pixels.
|
|
1096
1096
|
|
|
1097
|
-
Returns **
|
|
1097
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1098
1098
|
|
|
1099
1099
|
### rightClick
|
|
1100
1100
|
|
|
@@ -1114,7 +1114,7 @@ I.rightClick('Click me', '.context');
|
|
|
1114
1114
|
* `locator` **([string][3] | [object][4])** clickable element located by CSS|XPath|strict locator.
|
|
1115
1115
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
1116
1116
|
|
|
1117
|
-
Returns **
|
|
1117
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1118
1118
|
|
|
1119
1119
|
### saveElementScreenshot
|
|
1120
1120
|
|
|
@@ -1130,7 +1130,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
|
|
|
1130
1130
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1131
1131
|
* `fileName` **[string][3]** file name to save.
|
|
1132
1132
|
|
|
1133
|
-
Returns **
|
|
1133
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1134
1134
|
|
|
1135
1135
|
### saveScreenshot
|
|
1136
1136
|
|
|
@@ -1155,7 +1155,7 @@ Scroll page to the bottom.
|
|
|
1155
1155
|
I.scrollPageToBottom();
|
|
1156
1156
|
```
|
|
1157
1157
|
|
|
1158
|
-
Returns **
|
|
1158
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1159
1159
|
|
|
1160
1160
|
### scrollPageToTop
|
|
1161
1161
|
|
|
@@ -1165,7 +1165,7 @@ Scroll page to the top.
|
|
|
1165
1165
|
I.scrollPageToTop();
|
|
1166
1166
|
```
|
|
1167
1167
|
|
|
1168
|
-
Returns **
|
|
1168
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1169
1169
|
|
|
1170
1170
|
### scrollTo
|
|
1171
1171
|
|
|
@@ -1183,7 +1183,7 @@ I.scrollTo('#submit', 5, 5);
|
|
|
1183
1183
|
* `offsetX` **[number][8]** (optional, `0` by default) X-axis offset.
|
|
1184
1184
|
* `offsetY` **[number][8]** (optional, `0` by default) Y-axis offset.
|
|
1185
1185
|
|
|
1186
|
-
Returns **
|
|
1186
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1187
1187
|
|
|
1188
1188
|
### see
|
|
1189
1189
|
|
|
@@ -1201,7 +1201,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
|
|
|
1201
1201
|
* `text` **[string][3]** expected on page.
|
|
1202
1202
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
1203
1203
|
|
|
1204
|
-
Returns **
|
|
1204
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1205
1205
|
|
|
1206
1206
|
### seeAttributesOnElements
|
|
1207
1207
|
|
|
@@ -1216,7 +1216,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
|
|
|
1216
1216
|
* `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
|
|
1217
1217
|
* `attributes` **[object][4]** attributes and their values to check.
|
|
1218
1218
|
|
|
1219
|
-
Returns **
|
|
1219
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1220
1220
|
|
|
1221
1221
|
### seeCheckboxIsChecked
|
|
1222
1222
|
|
|
@@ -1233,7 +1233,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
|
|
|
1233
1233
|
* `locator`  
|
|
1234
1234
|
* `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
|
|
1235
1235
|
|
|
1236
|
-
Returns **
|
|
1236
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1237
1237
|
|
|
1238
1238
|
### seeClipboardEquals
|
|
1239
1239
|
|
|
@@ -1251,7 +1251,7 @@ in Chromium-based browsers, where read access is granted automatically.
|
|
|
1251
1251
|
|
|
1252
1252
|
* `text` **[string][3]** value to check.
|
|
1253
1253
|
|
|
1254
|
-
Returns **
|
|
1254
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1255
1255
|
|
|
1256
1256
|
### seeCookie
|
|
1257
1257
|
|
|
@@ -1265,7 +1265,7 @@ I.seeCookie('Auth');
|
|
|
1265
1265
|
|
|
1266
1266
|
* `name` **[string][3]** cookie name.
|
|
1267
1267
|
|
|
1268
|
-
Returns **
|
|
1268
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1269
1269
|
|
|
1270
1270
|
### seeCssPropertiesOnElements
|
|
1271
1271
|
|
|
@@ -1280,7 +1280,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
|
|
|
1280
1280
|
* `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
|
|
1281
1281
|
* `cssProperties` **[object][4]** object with CSS properties and their values to check.
|
|
1282
1282
|
|
|
1283
|
-
Returns **
|
|
1283
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1284
1284
|
|
|
1285
1285
|
### seeCurrentPathEquals
|
|
1286
1286
|
|
|
@@ -1296,7 +1296,7 @@ I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
|
|
|
1296
1296
|
|
|
1297
1297
|
* `path` **[string][3]** value to check.
|
|
1298
1298
|
|
|
1299
|
-
Returns **
|
|
1299
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1300
1300
|
|
|
1301
1301
|
### seeCurrentUrlEquals
|
|
1302
1302
|
|
|
@@ -1313,7 +1313,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
|
|
|
1313
1313
|
|
|
1314
1314
|
* `url` **[string][3]** value to check.
|
|
1315
1315
|
|
|
1316
|
-
Returns **
|
|
1316
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1317
1317
|
|
|
1318
1318
|
### seeElement
|
|
1319
1319
|
|
|
@@ -1336,7 +1336,7 @@ I.seeElement({role: 'dialog'});
|
|
|
1336
1336
|
* `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
|
|
1337
1337
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
1338
1338
|
|
|
1339
|
-
Returns **
|
|
1339
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1340
1340
|
|
|
1341
1341
|
### seeElementInDOM
|
|
1342
1342
|
|
|
@@ -1351,7 +1351,7 @@ I.seeElementInDOM('#modal');
|
|
|
1351
1351
|
|
|
1352
1352
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1353
1353
|
|
|
1354
|
-
Returns **
|
|
1354
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1355
1355
|
|
|
1356
1356
|
### seeInClipboard
|
|
1357
1357
|
|
|
@@ -1369,7 +1369,7 @@ in Chromium-based browsers, where read access is granted automatically.
|
|
|
1369
1369
|
|
|
1370
1370
|
* `text` **[string][3]** value to check.
|
|
1371
1371
|
|
|
1372
|
-
Returns **
|
|
1372
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1373
1373
|
|
|
1374
1374
|
### seeInCurrentUrl
|
|
1375
1375
|
|
|
@@ -1383,7 +1383,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
|
|
|
1383
1383
|
|
|
1384
1384
|
* `url` **[string][3]** a fragment to check
|
|
1385
1385
|
|
|
1386
|
-
Returns **
|
|
1386
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1387
1387
|
|
|
1388
1388
|
### seeInField
|
|
1389
1389
|
|
|
@@ -1407,7 +1407,7 @@ I.seeInField('Name', 'John', '.form-container');
|
|
|
1407
1407
|
* `value` **([string][3] | [object][4])** value to check.
|
|
1408
1408
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
1409
1409
|
|
|
1410
|
-
Returns **
|
|
1410
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1411
1411
|
|
|
1412
1412
|
### seeInSource
|
|
1413
1413
|
|
|
@@ -1421,7 +1421,7 @@ I.seeInSource('<h1>Green eggs & ham</h1>');
|
|
|
1421
1421
|
|
|
1422
1422
|
* `text` **[string][3]** value to check.
|
|
1423
1423
|
|
|
1424
|
-
Returns **
|
|
1424
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1425
1425
|
|
|
1426
1426
|
### seeInTitle
|
|
1427
1427
|
|
|
@@ -1435,7 +1435,7 @@ I.seeInTitle('Home Page');
|
|
|
1435
1435
|
|
|
1436
1436
|
* `text` **[string][3]** text value to check.
|
|
1437
1437
|
|
|
1438
|
-
Returns **
|
|
1438
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1439
1439
|
|
|
1440
1440
|
### seeNumberOfVisibleElements
|
|
1441
1441
|
|
|
@@ -1451,7 +1451,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
|
|
|
1451
1451
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1452
1452
|
* `num` **[number][8]** number of elements.
|
|
1453
1453
|
|
|
1454
|
-
Returns **
|
|
1454
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1455
1455
|
|
|
1456
1456
|
### seeTraffic
|
|
1457
1457
|
|
|
@@ -1527,7 +1527,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
|
|
|
1527
1527
|
* `option` **([string][3] | [Array][15]<any>)** visible text or value of option.
|
|
1528
1528
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
1529
1529
|
|
|
1530
|
-
Returns **
|
|
1530
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1531
1531
|
|
|
1532
1532
|
### setCookie
|
|
1533
1533
|
|
|
@@ -1549,7 +1549,7 @@ I.setCookie([
|
|
|
1549
1549
|
|
|
1550
1550
|
* `cookie` **(Cookie | [Array][15]<Cookie>)** a cookie object or array of cookie objects.
|
|
1551
1551
|
|
|
1552
|
-
Returns **
|
|
1552
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1553
1553
|
|
|
1554
1554
|
### startRecordingTraffic
|
|
1555
1555
|
|
|
@@ -1560,7 +1560,7 @@ This also resets recorded network requests.
|
|
|
1560
1560
|
I.startRecordingTraffic();
|
|
1561
1561
|
```
|
|
1562
1562
|
|
|
1563
|
-
Returns **
|
|
1563
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1564
1564
|
|
|
1565
1565
|
### startScreencast
|
|
1566
1566
|
|
|
@@ -1625,7 +1625,7 @@ I.type(secret('123456'));
|
|
|
1625
1625
|
* `delay` **[number][8]?** (optional) delay in ms between key presses
|
|
1626
1626
|
* `key` **([string][3] | [Array][15]<[string][3]>)** or array of keys to type.
|
|
1627
1627
|
|
|
1628
|
-
Returns **
|
|
1628
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1629
1629
|
|
|
1630
1630
|
### uncheckOption
|
|
1631
1631
|
|
|
@@ -1645,7 +1645,7 @@ I.uncheckOption('agree', '//form');
|
|
|
1645
1645
|
* `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
|
|
1646
1646
|
* `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
1647
1647
|
|
|
1648
|
-
Returns **
|
|
1648
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1649
1649
|
|
|
1650
1650
|
### wait
|
|
1651
1651
|
|
|
@@ -1659,7 +1659,7 @@ I.wait(2); // wait 2 secs
|
|
|
1659
1659
|
|
|
1660
1660
|
* `sec` **[number][8]** number of second to wait.
|
|
1661
1661
|
|
|
1662
|
-
Returns **
|
|
1662
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1663
1663
|
|
|
1664
1664
|
### waitCurrentPathEquals
|
|
1665
1665
|
|
|
@@ -1690,7 +1690,7 @@ I.waitForCookie("token");
|
|
|
1690
1690
|
* `name` **[string][3]** expected cookie name.
|
|
1691
1691
|
* `sec` **[number][8]** (optional, `3` by default) time in seconds to wait
|
|
1692
1692
|
|
|
1693
|
-
Returns **
|
|
1693
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1694
1694
|
|
|
1695
1695
|
### waitForDetached
|
|
1696
1696
|
|
|
@@ -1706,7 +1706,7 @@ I.waitForDetached('#popup');
|
|
|
1706
1706
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1707
1707
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1708
1708
|
|
|
1709
|
-
Returns **
|
|
1709
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1710
1710
|
|
|
1711
1711
|
### waitForElement
|
|
1712
1712
|
|
|
@@ -1723,7 +1723,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
|
|
|
1723
1723
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1724
1724
|
* `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
|
|
1725
1725
|
|
|
1726
|
-
Returns **
|
|
1726
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1727
1727
|
|
|
1728
1728
|
### waitForFunction
|
|
1729
1729
|
|
|
@@ -1746,7 +1746,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
|
|
|
1746
1746
|
* `argsOrSec` **([Array][15]<any> | [number][8])?** (optional, `1` by default) arguments for function or seconds.
|
|
1747
1747
|
* `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
|
|
1748
1748
|
|
|
1749
|
-
Returns **
|
|
1749
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1750
1750
|
|
|
1751
1751
|
### waitForInvisible
|
|
1752
1752
|
|
|
@@ -1762,7 +1762,7 @@ I.waitForInvisible('#popup');
|
|
|
1762
1762
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1763
1763
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1764
1764
|
|
|
1765
|
-
Returns **
|
|
1765
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1766
1766
|
|
|
1767
1767
|
### waitForText
|
|
1768
1768
|
|
|
@@ -1781,7 +1781,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
|
|
|
1781
1781
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1782
1782
|
* `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator.
|
|
1783
1783
|
|
|
1784
|
-
Returns **
|
|
1784
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1785
1785
|
|
|
1786
1786
|
### waitForVisible
|
|
1787
1787
|
|
|
@@ -1797,7 +1797,7 @@ I.waitForVisible('#popup');
|
|
|
1797
1797
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1798
1798
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1799
1799
|
|
|
1800
|
-
Returns **
|
|
1800
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1801
1801
|
|
|
1802
1802
|
### waitInUrl
|
|
1803
1803
|
|
|
@@ -1812,7 +1812,7 @@ I.waitInUrl('/info', 2);
|
|
|
1812
1812
|
* `urlPart` **[string][3]** value to check.
|
|
1813
1813
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1814
1814
|
|
|
1815
|
-
Returns **
|
|
1815
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1816
1816
|
|
|
1817
1817
|
### waitToHide
|
|
1818
1818
|
|
|
@@ -1828,7 +1828,7 @@ I.waitToHide('#popup');
|
|
|
1828
1828
|
* `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
|
|
1829
1829
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1830
1830
|
|
|
1831
|
-
Returns **
|
|
1831
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1832
1832
|
|
|
1833
1833
|
### waitUrlEquals
|
|
1834
1834
|
|
|
@@ -1844,7 +1844,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
|
|
|
1844
1844
|
* `urlPart` **[string][3]** value to check.
|
|
1845
1845
|
* `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
|
|
1846
1846
|
|
|
1847
|
-
Returns **
|
|
1847
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1848
1848
|
|
|
1849
1849
|
### _connect
|
|
1850
1850
|
|