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.
Files changed (74) hide show
  1. package/README.md +4 -4
  2. package/docs/ai.md +1 -1
  3. package/docs/alternative-browsers.md +4 -4
  4. package/docs/api.md +13 -13
  5. package/docs/assertions.md +6 -6
  6. package/docs/best.md +1 -1
  7. package/docs/bootstrap.md +1 -1
  8. package/docs/data.md +8 -8
  9. package/docs/element-selection.md +27 -4
  10. package/docs/helpers/ApiDataFactory.md +2 -2
  11. package/docs/helpers/Appium.md +56 -56
  12. package/docs/helpers/Decision.md +1 -1
  13. package/docs/helpers/Detox.md +1 -1
  14. package/docs/helpers/ExpectHelper.md +1 -1
  15. package/docs/helpers/FileSystem.md +1 -1
  16. package/docs/helpers/GraphQL.md +1 -1
  17. package/docs/helpers/GraphQLDataFactory.md +2 -2
  18. package/docs/helpers/JSONResponse.md +1 -1
  19. package/docs/helpers/Kitesurf.md +65 -65
  20. package/docs/helpers/Lightpanda.md +65 -65
  21. package/docs/helpers/MockRequest.md +1 -1
  22. package/docs/helpers/Moli.md +65 -65
  23. package/docs/helpers/Obscura.md +65 -65
  24. package/docs/helpers/Playwright.md +127 -127
  25. package/docs/helpers/Puppeteer.md +88 -88
  26. package/docs/helpers/REST.md +1 -1
  27. package/docs/helpers/WebDriver.md +87 -87
  28. package/docs/installation.md +1 -1
  29. package/docs/locators.md +5 -7
  30. package/docs/migration-4.md +7 -3
  31. package/docs/mobile.md +2 -2
  32. package/docs/parallel.md +1 -1
  33. package/docs/playwright.md +5 -5
  34. package/docs/plugins/aiTrace.md +1 -1
  35. package/docs/plugins/autoDelay.md +1 -1
  36. package/docs/plugins/customLocator.md +1 -1
  37. package/docs/plugins/customReporter.md +1 -1
  38. package/docs/plugins/junitReporter.md +2 -2
  39. package/docs/plugins/pageInfo.md +1 -1
  40. package/docs/plugins/pauseOnFail.md +1 -1
  41. package/docs/plugins/retryFailedStep.md +1 -1
  42. package/docs/plugins/screenshotOnFail.md +1 -1
  43. package/docs/plugins/stepTimeout.md +1 -1
  44. package/docs/plugins.md +10 -10
  45. package/docs/puppeteer.md +4 -4
  46. package/docs/retry.md +1 -1
  47. package/docs/timeouts.md +7 -7
  48. package/docs/webdriver.md +8 -8
  49. package/lib/actor.js +20 -2
  50. package/lib/aria.js +1 -0
  51. package/lib/codecept.js +1 -1
  52. package/lib/data/context.js +24 -0
  53. package/lib/element/WebElement.js +5 -5
  54. package/lib/helper/ApiDataFactory.js +1 -1
  55. package/lib/helper/Appium.js +2 -2
  56. package/lib/helper/GraphQLDataFactory.js +1 -1
  57. package/lib/helper/Playwright.js +22 -12
  58. package/lib/helper/Puppeteer.js +5 -11
  59. package/lib/mocha/asyncWrapper.js +14 -3
  60. package/lib/mocha/test.js +1 -0
  61. package/lib/plugin/auth.js +3 -0
  62. package/lib/plugin/junitReporter.js +21 -12
  63. package/lib/recorder.js +22 -3
  64. package/lib/step/base.js +8 -1
  65. package/lib/step/func.js +1 -1
  66. package/lib/step/helper.js +1 -1
  67. package/lib/step/record.js +22 -17
  68. package/lib/step/retry.js +13 -6
  69. package/lib/utils/typescript.js +86 -12
  70. package/lib/workers.js +15 -0
  71. package/package.json +2 -1
  72. package/typings/index.d.ts +12 -0
  73. package/typings/promiseBasedTypes.d.ts +696 -351
  74. package/typings/types.d.ts +485 -352
@@ -1,5 +1,5 @@
1
1
  ---
2
- permalink: /helpers/Lightpanda
2
+ permalink: /helpers/lightpanda
3
3
  editLink: false
4
4
  sidebar: auto
5
5
  title: Lightpanda
@@ -153,7 +153,7 @@ I.amOnPage('/login'); // opens a login page
153
153
 
154
154
  * `url` **[string][3]** url path or global url.
155
155
 
156
- Returns **void** automatically synchronized promise through #recorder
156
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
157
157
 
158
158
  ### appendField
159
159
 
@@ -176,7 +176,7 @@ I.appendField('name', 'John', '.form-container');
176
176
  * `value` **[string][3]** text value to append.
177
177
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
178
178
 
179
- Returns **void** automatically synchronized promise through #recorder
179
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
180
180
 
181
181
  ### attachFile
182
182
 
@@ -207,7 +207,7 @@ I.attachFile('#dropzone', 'data/avatar.jpg');
207
207
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
208
208
  * `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
209
209
 
210
- Returns **void** automatically synchronized promise through #recorder
210
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
211
211
 
212
212
  ### blur
213
213
 
@@ -232,7 +232,7 @@ I.dontSee('#add-to-cart-btn');
232
232
  * `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
233
233
  * `options` **any?** Playwright only: [Additional options][6] for available options object as 2nd argument.
234
234
 
235
- Returns **void** automatically synchronized promise through #recorder
235
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
236
236
 
237
237
  ### capabilities
238
238
 
@@ -256,7 +256,7 @@ I.checkOption('agree', '//form');
256
256
  * `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
257
257
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
258
258
 
259
- Returns **void** automatically synchronized promise through #recorder
259
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
260
260
 
261
261
  ### clearClipboard
262
262
 
@@ -267,7 +267,7 @@ I.clearClipboard();
267
267
  I.seeClipboardEquals('');
268
268
  ```
269
269
 
270
- Returns **void** automatically synchronized promise through #recorder
270
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
271
271
 
272
272
  ### clearCookie
273
273
 
@@ -304,7 +304,7 @@ I.clearField('Email', '.form-container');
304
304
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
305
305
  * `editable` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
306
306
 
307
- Returns **void** automatically synchronized promise through #recorder.
307
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder.
308
308
 
309
309
  ### click
310
310
 
@@ -343,7 +343,7 @@ I.click({role: 'button', name: 'Submit'});
343
343
  * `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.
344
344
  * `context` **([string][3]? | [object][4] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
345
345
 
346
- Returns **void** automatically synchronized promise through #recorder
346
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
347
347
 
348
348
  ### clickXY
349
349
 
@@ -378,7 +378,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
378
378
  * `text` **[string][3]** which is not present.
379
379
  * `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
380
380
 
381
- Returns **void** automatically synchronized promise through #recorder
381
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
382
382
 
383
383
  ### dontSeeCheckboxIsChecked
384
384
 
@@ -395,7 +395,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
395
395
  * `locator`  
396
396
  * `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
397
397
 
398
- Returns **void** automatically synchronized promise through #recorder
398
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
399
399
 
400
400
  ### dontSeeCookie
401
401
 
@@ -409,7 +409,7 @@ I.dontSeeCookie('auth'); // no auth cookie
409
409
 
410
410
  * `name` **[string][3]** cookie name.
411
411
 
412
- Returns **void** automatically synchronized promise through #recorder
412
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
413
413
 
414
414
  ### dontSeeCurrentPathEquals
415
415
 
@@ -425,7 +425,7 @@ I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
425
425
 
426
426
  * `path` **[string][3]** value to check.
427
427
 
428
- Returns **void** automatically synchronized promise through #recorder
428
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
429
429
 
430
430
  ### dontSeeCurrentUrlEquals
431
431
 
@@ -441,7 +441,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
441
441
 
442
442
  * `url` **[string][3]** value to check.
443
443
 
444
- Returns **void** automatically synchronized promise through #recorder
444
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
445
445
 
446
446
  ### dontSeeElement
447
447
 
@@ -459,7 +459,7 @@ I.dontSeeElement('.modal', '#container');
459
459
  * `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
460
460
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
461
461
 
462
- Returns **void** automatically synchronized promise through #recorder
462
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
463
463
 
464
464
  ### dontSeeElementInDOM
465
465
 
@@ -473,7 +473,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
473
473
 
474
474
  * `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
475
475
 
476
- Returns **void** automatically synchronized promise through #recorder
476
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
477
477
 
478
478
  ### dontSeeInCurrentUrl
479
479
 
@@ -483,7 +483,7 @@ Checks that current url does not contain a provided fragment.
483
483
 
484
484
  * `url` **[string][3]** value to check.
485
485
 
486
- Returns **void** automatically synchronized promise through #recorder
486
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
487
487
 
488
488
  ### dontSeeInField
489
489
 
@@ -505,7 +505,7 @@ I.dontSeeInField('Name', 'old_value', '.form-container');
505
505
  * `value` **([string][3] | [object][4])** value to check.
506
506
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
507
507
 
508
- Returns **void** automatically synchronized promise through #recorder
508
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
509
509
 
510
510
  ### dontSeeInSource
511
511
 
@@ -520,7 +520,7 @@ I.dontSeeInSource('<!--'); // no comments in source
520
520
  * `text` &#x20;
521
521
  * `value` **[string][3]** to check.
522
522
 
523
- Returns **void** automatically synchronized promise through #recorder
523
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
524
524
 
525
525
  ### dontSeeInTitle
526
526
 
@@ -534,7 +534,7 @@ I.dontSeeInTitle('Error');
534
534
 
535
535
  * `text` **[string][3]** value to check.
536
536
 
537
- Returns **void** automatically synchronized promise through #recorder
537
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
538
538
 
539
539
  ### dontSeeTraffic
540
540
 
@@ -573,7 +573,7 @@ I.doubleClick('.btn.edit');
573
573
  * `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
574
574
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
575
575
 
576
- Returns **void** automatically synchronized promise through #recorder
576
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
577
577
 
578
578
  ### executeAsyncScript
579
579
 
@@ -668,7 +668,7 @@ I.fillField('Name', 'John', '#section2');
668
668
  * `value` **([string][3] | [object][4])** text value to fill.
669
669
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
670
670
 
671
- Returns **void** automatically synchronized promise through #recorder
671
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
672
672
 
673
673
  ### flushNetworkTraffics
674
674
 
@@ -695,7 +695,7 @@ I.see('#add-to-cart-bnt');
695
695
  * `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
696
696
  * `options` **any?** Playwright only: [Additional options][13] for available options object as 2nd argument.
697
697
 
698
- Returns **void** automatically synchronized promise through #recorder
698
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
699
699
 
700
700
  ### forceClick
701
701
 
@@ -729,7 +729,7 @@ I.forceClick({css: 'nav a.login'});
729
729
  * `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
730
730
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
731
731
 
732
- Returns **void** automatically synchronized promise through #recorder
732
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
733
733
 
734
734
  ### grabAriaSnapshot
735
735
 
@@ -1053,7 +1053,7 @@ const webElement = await I.grabWebElement('#button');
1053
1053
 
1054
1054
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1055
1055
 
1056
- Returns **[Promise][12]<any>** WebElement of being used Web helper
1056
+ Returns **[Promise][12]<CodeceptJS.WebElement>** WebElement of being used Web helper
1057
1057
 
1058
1058
  ### grabWebElements
1059
1059
 
@@ -1068,7 +1068,7 @@ const webElements = await I.grabWebElements('#button');
1068
1068
 
1069
1069
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1070
1070
 
1071
- Returns **[Promise][12]<any>** WebElement of being used Web helper
1071
+ Returns **[Promise][12]<[Array][15]<CodeceptJS.WebElement>>** WebElements of being used Web helper
1072
1072
 
1073
1073
  ### pressKey
1074
1074
 
@@ -1093,7 +1093,7 @@ Reload the current page.
1093
1093
  I.refreshPage();
1094
1094
  ```
1095
1095
 
1096
- Returns **void** automatically synchronized promise through #recorder
1096
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1097
1097
 
1098
1098
  ### resizeWindow
1099
1099
 
@@ -1105,7 +1105,7 @@ First parameter can be set to `maximize`.
1105
1105
  * `width` **[number][8]** width in pixels or `maximize`.
1106
1106
  * `height` **[number][8]** height in pixels.
1107
1107
 
1108
- Returns **void** automatically synchronized promise through #recorder
1108
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1109
1109
 
1110
1110
  ### rightClick
1111
1111
 
@@ -1125,7 +1125,7 @@ I.rightClick('Click me', '.context');
1125
1125
  * `locator` **([string][3] | [object][4])** clickable element located by CSS|XPath|strict locator.
1126
1126
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|XPath|strict locator.
1127
1127
 
1128
- Returns **void** automatically synchronized promise through #recorder
1128
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1129
1129
 
1130
1130
  ### saveElementScreenshot
1131
1131
 
@@ -1141,7 +1141,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
1141
1141
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1142
1142
  * `fileName` **[string][3]** file name to save.
1143
1143
 
1144
- Returns **void** automatically synchronized promise through #recorder
1144
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1145
1145
 
1146
1146
  ### saveScreenshot
1147
1147
 
@@ -1166,7 +1166,7 @@ Scroll page to the bottom.
1166
1166
  I.scrollPageToBottom();
1167
1167
  ```
1168
1168
 
1169
- Returns **void** automatically synchronized promise through #recorder
1169
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1170
1170
 
1171
1171
  ### scrollPageToTop
1172
1172
 
@@ -1176,7 +1176,7 @@ Scroll page to the top.
1176
1176
  I.scrollPageToTop();
1177
1177
  ```
1178
1178
 
1179
- Returns **void** automatically synchronized promise through #recorder
1179
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1180
1180
 
1181
1181
  ### scrollTo
1182
1182
 
@@ -1194,7 +1194,7 @@ I.scrollTo('#submit', 5, 5);
1194
1194
  * `offsetX` **[number][8]** (optional, `0` by default) X-axis offset.
1195
1195
  * `offsetY` **[number][8]** (optional, `0` by default) Y-axis offset.
1196
1196
 
1197
- Returns **void** automatically synchronized promise through #recorder
1197
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1198
1198
 
1199
1199
  ### see
1200
1200
 
@@ -1212,7 +1212,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
1212
1212
  * `text` **[string][3]** expected on page.
1213
1213
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1214
1214
 
1215
- Returns **void** automatically synchronized promise through #recorder
1215
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1216
1216
 
1217
1217
  ### seeAttributesOnElements
1218
1218
 
@@ -1227,7 +1227,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
1227
1227
  * `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
1228
1228
  * `attributes` **[object][4]** attributes and their values to check.
1229
1229
 
1230
- Returns **void** automatically synchronized promise through #recorder
1230
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1231
1231
 
1232
1232
  ### seeCheckboxIsChecked
1233
1233
 
@@ -1244,7 +1244,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
1244
1244
  * `locator` &#x20;
1245
1245
  * `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
1246
1246
 
1247
- Returns **void** automatically synchronized promise through #recorder
1247
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1248
1248
 
1249
1249
  ### seeClipboardEquals
1250
1250
 
@@ -1262,7 +1262,7 @@ in Chromium-based browsers, where read access is granted automatically.
1262
1262
 
1263
1263
  * `text` **[string][3]** value to check.
1264
1264
 
1265
- Returns **void** automatically synchronized promise through #recorder
1265
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1266
1266
 
1267
1267
  ### seeCookie
1268
1268
 
@@ -1276,7 +1276,7 @@ I.seeCookie('Auth');
1276
1276
 
1277
1277
  * `name` **[string][3]** cookie name.
1278
1278
 
1279
- Returns **void** automatically synchronized promise through #recorder
1279
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1280
1280
 
1281
1281
  ### seeCssPropertiesOnElements
1282
1282
 
@@ -1291,7 +1291,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
1291
1291
  * `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
1292
1292
  * `cssProperties` **[object][4]** object with CSS properties and their values to check.
1293
1293
 
1294
- Returns **void** automatically synchronized promise through #recorder
1294
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1295
1295
 
1296
1296
  ### seeCurrentPathEquals
1297
1297
 
@@ -1307,7 +1307,7 @@ I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
1307
1307
 
1308
1308
  * `path` **[string][3]** value to check.
1309
1309
 
1310
- Returns **void** automatically synchronized promise through #recorder
1310
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1311
1311
 
1312
1312
  ### seeCurrentUrlEquals
1313
1313
 
@@ -1324,7 +1324,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
1324
1324
 
1325
1325
  * `url` **[string][3]** value to check.
1326
1326
 
1327
- Returns **void** automatically synchronized promise through #recorder
1327
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1328
1328
 
1329
1329
  ### seeElement
1330
1330
 
@@ -1347,7 +1347,7 @@ I.seeElement({role: 'dialog'});
1347
1347
  * `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
1348
1348
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1349
1349
 
1350
- Returns **void** automatically synchronized promise through #recorder
1350
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1351
1351
 
1352
1352
  ### seeElementInDOM
1353
1353
 
@@ -1362,7 +1362,7 @@ I.seeElementInDOM('#modal');
1362
1362
 
1363
1363
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1364
1364
 
1365
- Returns **void** automatically synchronized promise through #recorder
1365
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1366
1366
 
1367
1367
  ### seeInClipboard
1368
1368
 
@@ -1380,7 +1380,7 @@ in Chromium-based browsers, where read access is granted automatically.
1380
1380
 
1381
1381
  * `text` **[string][3]** value to check.
1382
1382
 
1383
- Returns **void** automatically synchronized promise through #recorder
1383
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1384
1384
 
1385
1385
  ### seeInCurrentUrl
1386
1386
 
@@ -1394,7 +1394,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
1394
1394
 
1395
1395
  * `url` **[string][3]** a fragment to check
1396
1396
 
1397
- Returns **void** automatically synchronized promise through #recorder
1397
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1398
1398
 
1399
1399
  ### seeInField
1400
1400
 
@@ -1418,7 +1418,7 @@ I.seeInField('Name', 'John', '.form-container');
1418
1418
  * `value` **([string][3] | [object][4])** value to check.
1419
1419
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1420
1420
 
1421
- Returns **void** automatically synchronized promise through #recorder
1421
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1422
1422
 
1423
1423
  ### seeInSource
1424
1424
 
@@ -1432,7 +1432,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
1432
1432
 
1433
1433
  * `text` **[string][3]** value to check.
1434
1434
 
1435
- Returns **void** automatically synchronized promise through #recorder
1435
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1436
1436
 
1437
1437
  ### seeInTitle
1438
1438
 
@@ -1446,7 +1446,7 @@ I.seeInTitle('Home Page');
1446
1446
 
1447
1447
  * `text` **[string][3]** text value to check.
1448
1448
 
1449
- Returns **void** automatically synchronized promise through #recorder
1449
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1450
1450
 
1451
1451
  ### seeNumberOfVisibleElements
1452
1452
 
@@ -1462,7 +1462,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
1462
1462
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1463
1463
  * `num` **[number][8]** number of elements.
1464
1464
 
1465
- Returns **void** automatically synchronized promise through #recorder
1465
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1466
1466
 
1467
1467
  ### seeTraffic
1468
1468
 
@@ -1538,7 +1538,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
1538
1538
  * `option` **([string][3] | [Array][15]<any>)** visible text or value of option.
1539
1539
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1540
1540
 
1541
- Returns **void** automatically synchronized promise through #recorder
1541
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1542
1542
 
1543
1543
  ### setCookie
1544
1544
 
@@ -1560,7 +1560,7 @@ I.setCookie([
1560
1560
 
1561
1561
  * `cookie` **(Cookie | [Array][15]<Cookie>)** a cookie object or array of cookie objects.
1562
1562
 
1563
- Returns **void** automatically synchronized promise through #recorder
1563
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1564
1564
 
1565
1565
  ### startRecordingTraffic
1566
1566
 
@@ -1571,7 +1571,7 @@ This also resets recorded network requests.
1571
1571
  I.startRecordingTraffic();
1572
1572
  ```
1573
1573
 
1574
- Returns **void** automatically synchronized promise through #recorder
1574
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1575
1575
 
1576
1576
  ### startScreencast
1577
1577
 
@@ -1636,7 +1636,7 @@ I.type(secret('123456'));
1636
1636
  * `delay` **[number][8]?** (optional) delay in ms between key presses
1637
1637
  * `key` **([string][3] | [Array][15]<[string][3]>)** or array of keys to type.
1638
1638
 
1639
- Returns **void** automatically synchronized promise through #recorder
1639
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1640
1640
 
1641
1641
  ### uncheckOption
1642
1642
 
@@ -1656,7 +1656,7 @@ I.uncheckOption('agree', '//form');
1656
1656
  * `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator.
1657
1657
  * `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1658
1658
 
1659
- Returns **void** automatically synchronized promise through #recorder
1659
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1660
1660
 
1661
1661
  ### wait
1662
1662
 
@@ -1670,7 +1670,7 @@ I.wait(2); // wait 2 secs
1670
1670
 
1671
1671
  * `sec` **[number][8]** number of second to wait.
1672
1672
 
1673
- Returns **void** automatically synchronized promise through #recorder
1673
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1674
1674
 
1675
1675
  ### waitCurrentPathEquals
1676
1676
 
@@ -1701,7 +1701,7 @@ I.waitForCookie("token");
1701
1701
  * `name` **[string][3]** expected cookie name.
1702
1702
  * `sec` **[number][8]** (optional, `3` by default) time in seconds to wait
1703
1703
 
1704
- Returns **void** automatically synchronized promise through #recorder
1704
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1705
1705
 
1706
1706
  ### waitForDetached
1707
1707
 
@@ -1717,7 +1717,7 @@ I.waitForDetached('#popup');
1717
1717
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1718
1718
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1719
1719
 
1720
- Returns **void** automatically synchronized promise through #recorder
1720
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1721
1721
 
1722
1722
  ### waitForElement
1723
1723
 
@@ -1734,7 +1734,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
1734
1734
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1735
1735
  * `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
1736
1736
 
1737
- Returns **void** automatically synchronized promise through #recorder
1737
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1738
1738
 
1739
1739
  ### waitForFunction
1740
1740
 
@@ -1757,7 +1757,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
1757
1757
  * `argsOrSec` **([Array][15]<any> | [number][8])?** (optional, `1` by default) arguments for function or seconds.
1758
1758
  * `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
1759
1759
 
1760
- Returns **void** automatically synchronized promise through #recorder
1760
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1761
1761
 
1762
1762
  ### waitForInvisible
1763
1763
 
@@ -1773,7 +1773,7 @@ I.waitForInvisible('#popup');
1773
1773
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1774
1774
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1775
1775
 
1776
- Returns **void** automatically synchronized promise through #recorder
1776
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1777
1777
 
1778
1778
  ### waitForText
1779
1779
 
@@ -1792,7 +1792,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
1792
1792
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1793
1793
  * `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator.
1794
1794
 
1795
- Returns **void** automatically synchronized promise through #recorder
1795
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1796
1796
 
1797
1797
  ### waitForVisible
1798
1798
 
@@ -1808,7 +1808,7 @@ I.waitForVisible('#popup');
1808
1808
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1809
1809
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1810
1810
 
1811
- Returns **void** automatically synchronized promise through #recorder
1811
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1812
1812
 
1813
1813
  ### waitInUrl
1814
1814
 
@@ -1823,7 +1823,7 @@ I.waitInUrl('/info', 2);
1823
1823
  * `urlPart` **[string][3]** value to check.
1824
1824
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1825
1825
 
1826
- Returns **void** automatically synchronized promise through #recorder
1826
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1827
1827
 
1828
1828
  ### waitToHide
1829
1829
 
@@ -1839,7 +1839,7 @@ I.waitToHide('#popup');
1839
1839
  * `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
1840
1840
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1841
1841
 
1842
- Returns **void** automatically synchronized promise through #recorder
1842
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1843
1843
 
1844
1844
  ### waitUrlEquals
1845
1845
 
@@ -1855,7 +1855,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
1855
1855
  * `urlPart` **[string][3]** value to check.
1856
1856
  * `sec` **[number][8]** (optional, `1` by default) time in seconds to wait
1857
1857
 
1858
- Returns **void** automatically synchronized promise through #recorder
1858
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1859
1859
 
1860
1860
  ### _connect
1861
1861
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- permalink: /helpers/MockRequest
2
+ permalink: /helpers/mock-request
3
3
  sidebar: auto
4
4
  title: MockRequest
5
5
  ---