codeceptjs 3.5.7 → 3.5.9-beta.1

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 (108) hide show
  1. package/README.md +1 -1
  2. package/docs/build/Appium.js +27 -22
  3. package/docs/build/Nightmare.js +51 -52
  4. package/docs/build/Playwright.js +75 -75
  5. package/docs/build/Protractor.js +64 -65
  6. package/docs/build/Puppeteer.js +74 -75
  7. package/docs/build/TestCafe.js +54 -55
  8. package/docs/build/WebDriver.js +79 -80
  9. package/docs/changelog.md +1 -562
  10. package/docs/community-helpers.md +4 -8
  11. package/docs/examples.md +2 -8
  12. package/docs/helpers/Appium.md +85 -83
  13. package/docs/helpers/Nightmare.md +75 -77
  14. package/docs/helpers/Playwright.md +175 -177
  15. package/docs/helpers/Protractor.md +153 -155
  16. package/docs/helpers/Puppeteer.md +146 -148
  17. package/docs/helpers/TestCafe.md +124 -126
  18. package/docs/helpers/WebDriver.md +155 -157
  19. package/docs/webapi/amOnPage.mustache +1 -1
  20. package/docs/webapi/appendField.mustache +1 -1
  21. package/docs/webapi/attachFile.mustache +1 -1
  22. package/docs/webapi/blur.mustache +1 -1
  23. package/docs/webapi/checkOption.mustache +1 -1
  24. package/docs/webapi/clearCookie.mustache +1 -2
  25. package/docs/webapi/clearField.mustache +1 -1
  26. package/docs/webapi/click.mustache +1 -1
  27. package/docs/webapi/clickLink.mustache +1 -1
  28. package/docs/webapi/closeCurrentTab.mustache +1 -1
  29. package/docs/webapi/closeOtherTabs.mustache +1 -1
  30. package/docs/webapi/dontSee.mustache +1 -1
  31. package/docs/webapi/dontSeeCheckboxIsChecked.mustache +1 -1
  32. package/docs/webapi/dontSeeCookie.mustache +1 -1
  33. package/docs/webapi/dontSeeCurrentUrlEquals.mustache +1 -1
  34. package/docs/webapi/dontSeeElement.mustache +1 -1
  35. package/docs/webapi/dontSeeElementInDOM.mustache +1 -1
  36. package/docs/webapi/dontSeeInCurrentUrl.mustache +1 -1
  37. package/docs/webapi/dontSeeInField.mustache +1 -1
  38. package/docs/webapi/dontSeeInSource.mustache +1 -1
  39. package/docs/webapi/dontSeeInTitle.mustache +1 -1
  40. package/docs/webapi/doubleClick.mustache +1 -1
  41. package/docs/webapi/downloadFile.mustache +1 -1
  42. package/docs/webapi/dragAndDrop.mustache +1 -1
  43. package/docs/webapi/dragSlider.mustache +1 -1
  44. package/docs/webapi/fillField.mustache +1 -1
  45. package/docs/webapi/focus.mustache +1 -1
  46. package/docs/webapi/forceClick.mustache +1 -1
  47. package/docs/webapi/forceRightClick.mustache +1 -1
  48. package/docs/webapi/grabDataFromPerformanceTiming.mustache +1 -1
  49. package/docs/webapi/moveCursorTo.mustache +1 -1
  50. package/docs/webapi/openNewTab.mustache +1 -1
  51. package/docs/webapi/pressKey.mustache +1 -1
  52. package/docs/webapi/pressKeyDown.mustache +1 -1
  53. package/docs/webapi/pressKeyUp.mustache +1 -1
  54. package/docs/webapi/pressKeyWithKeyNormalization.mustache +1 -1
  55. package/docs/webapi/refreshPage.mustache +1 -1
  56. package/docs/webapi/resizeWindow.mustache +1 -1
  57. package/docs/webapi/rightClick.mustache +1 -1
  58. package/docs/webapi/saveElementScreenshot.mustache +1 -1
  59. package/docs/webapi/saveScreenshot.mustache +1 -1
  60. package/docs/webapi/say.mustache +1 -1
  61. package/docs/webapi/scrollIntoView.mustache +1 -1
  62. package/docs/webapi/scrollPageToBottom.mustache +1 -1
  63. package/docs/webapi/scrollPageToTop.mustache +1 -1
  64. package/docs/webapi/scrollTo.mustache +1 -1
  65. package/docs/webapi/see.mustache +1 -1
  66. package/docs/webapi/seeAttributesOnElements.mustache +1 -1
  67. package/docs/webapi/seeCheckboxIsChecked.mustache +1 -1
  68. package/docs/webapi/seeCookie.mustache +1 -1
  69. package/docs/webapi/seeCssPropertiesOnElements.mustache +1 -1
  70. package/docs/webapi/seeCurrentUrlEquals.mustache +1 -1
  71. package/docs/webapi/seeElement.mustache +1 -1
  72. package/docs/webapi/seeElementInDOM.mustache +1 -1
  73. package/docs/webapi/seeInCurrentUrl.mustache +1 -1
  74. package/docs/webapi/seeInField.mustache +1 -1
  75. package/docs/webapi/seeInPopup.mustache +1 -1
  76. package/docs/webapi/seeInSource.mustache +1 -1
  77. package/docs/webapi/seeInTitle.mustache +1 -1
  78. package/docs/webapi/seeNumberOfElements.mustache +1 -1
  79. package/docs/webapi/seeNumberOfVisibleElements.mustache +1 -1
  80. package/docs/webapi/seeTextEquals.mustache +1 -1
  81. package/docs/webapi/seeTitleEquals.mustache +1 -1
  82. package/docs/webapi/selectOption.mustache +1 -1
  83. package/docs/webapi/setCookie.mustache +1 -1
  84. package/docs/webapi/setGeoLocation.mustache +1 -1
  85. package/docs/webapi/switchTo.mustache +1 -1
  86. package/docs/webapi/switchToNextTab.mustache +1 -1
  87. package/docs/webapi/switchToPreviousTab.mustache +1 -1
  88. package/docs/webapi/type.mustache +1 -1
  89. package/docs/webapi/uncheckOption.mustache +1 -1
  90. package/docs/webapi/wait.mustache +1 -1
  91. package/docs/webapi/waitForClickable.mustache +1 -1
  92. package/docs/webapi/waitForDetached.mustache +1 -1
  93. package/docs/webapi/waitForElement.mustache +1 -1
  94. package/docs/webapi/waitForEnabled.mustache +1 -1
  95. package/docs/webapi/waitForFunction.mustache +1 -1
  96. package/docs/webapi/waitForInvisible.mustache +1 -1
  97. package/docs/webapi/waitForText.mustache +1 -1
  98. package/docs/webapi/waitForValue.mustache +1 -1
  99. package/docs/webapi/waitForVisible.mustache +1 -1
  100. package/docs/webapi/waitInUrl.mustache +1 -1
  101. package/docs/webapi/waitNumberOfVisibleElements.mustache +1 -1
  102. package/docs/webapi/waitToHide.mustache +1 -1
  103. package/docs/webapi/waitUrlEquals.mustache +1 -1
  104. package/lib/helper/Appium.js +9 -4
  105. package/lib/helper/Playwright.js +3 -2
  106. package/package.json +5 -5
  107. package/typings/promiseBasedTypes.d.ts +423 -1010
  108. package/typings/types.d.ts +423 -427
@@ -456,7 +456,7 @@ class Protractor extends Helper {
456
456
  * ```
457
457
  *
458
458
  * @param {string} url url path or global url.
459
- * @returns {Promise<void>} automatically synchronized promise through #recorder
459
+ * @returns {void} automatically synchronized promise through #recorder
460
460
  *
461
461
  */
462
462
  async amOnPage(url) {
@@ -493,7 +493,7 @@ class Protractor extends Helper {
493
493
  *
494
494
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
495
495
  * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
496
- * @returns {Promise<void>} automatically synchronized promise through #recorder
496
+ * @returns {void} automatically synchronized promise through #recorder
497
497
  *
498
498
  */
499
499
  async click(locator, context = null) {
@@ -520,7 +520,7 @@ class Protractor extends Helper {
520
520
  *
521
521
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
522
522
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
523
- * @returns {Promise<void>} automatically synchronized promise through #recorder
523
+ * @returns {void} automatically synchronized promise through #recorder
524
524
  *
525
525
  */
526
526
  async doubleClick(locator, context = null) {
@@ -548,7 +548,7 @@ class Protractor extends Helper {
548
548
  *
549
549
  * @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
550
550
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
551
- * @returns {Promise<void>} automatically synchronized promise through #recorder
551
+ * @returns {void} automatically synchronized promise through #recorder
552
552
  *
553
553
  */
554
554
  async rightClick(locator, context = null) {
@@ -582,7 +582,7 @@ class Protractor extends Helper {
582
582
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
583
583
  * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
584
584
  * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
585
- * @returns {Promise<void>} automatically synchronized promise through #recorder
585
+ * @returns {void} automatically synchronized promise through #recorder
586
586
  *
587
587
  */
588
588
  async moveCursorTo(locator, offsetX = null, offsetY = null) {
@@ -606,7 +606,7 @@ class Protractor extends Helper {
606
606
  * ```
607
607
  * @param {string} text expected on page.
608
608
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
609
- * @returns {Promise<void>} automatically synchronized promise through #recorder
609
+ * @returns {void} automatically synchronized promise through #recorder
610
610
  *
611
611
  */
612
612
  async see(text, context = null) {
@@ -622,7 +622,7 @@ class Protractor extends Helper {
622
622
  *
623
623
  * @param {string} text element value to check.
624
624
  * @param {CodeceptJS.LocatorOrString?} [context=null] element located by CSS|XPath|strict locator.
625
- * @returns {Promise<void>} automatically synchronized promise through #recorder
625
+ * @returns {void} automatically synchronized promise through #recorder
626
626
  *
627
627
  */
628
628
  async seeTextEquals(text, context = null) {
@@ -640,7 +640,7 @@ class Protractor extends Helper {
640
640
  *
641
641
  * @param {string} text which is not present.
642
642
  * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
643
- * @returns {Promise<void>} automatically synchronized promise through #recorder
643
+ * @returns {void} automatically synchronized promise through #recorder
644
644
  *
645
645
  */
646
646
  dontSee(text, context = null) {
@@ -699,7 +699,7 @@ class Protractor extends Helper {
699
699
  * ```
700
700
  * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
701
701
  * @param {string|Array<*>} option visible text or value of option.
702
- * @returns {Promise<void>} automatically synchronized promise through #recorder
702
+ * @returns {void} automatically synchronized promise through #recorder
703
703
  *
704
704
  */
705
705
  async selectOption(select, option) {
@@ -738,7 +738,7 @@ class Protractor extends Helper {
738
738
  * ```
739
739
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
740
740
  * @param {CodeceptJS.StringOrSecret} value text value to fill.
741
- * @returns {Promise<void>} automatically synchronized promise through #recorder
741
+ * @returns {void} automatically synchronized promise through #recorder
742
742
  *
743
743
  */
744
744
  async fillField(field, value) {
@@ -759,7 +759,7 @@ class Protractor extends Helper {
759
759
  * ```
760
760
  *
761
761
  * @param {string|string[]} key key or array of keys to press.
762
- * @returns {Promise<void>} automatically synchronized promise through #recorder
762
+ * @returns {void} automatically synchronized promise through #recorder
763
763
  *
764
764
  * {{ keys }}
765
765
  */
@@ -794,7 +794,7 @@ class Protractor extends Helper {
794
794
  *
795
795
  * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
796
796
  * @param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
797
- * @returns {Promise<void>} automatically synchronized promise through #recorder
797
+ * @returns {void} automatically synchronized promise through #recorder
798
798
  *
799
799
  */
800
800
  async attachFile(locator, pathToFile) {
@@ -823,7 +823,7 @@ class Protractor extends Helper {
823
823
  * ```
824
824
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
825
825
  * @param {CodeceptJS.StringOrSecret} value value to check.
826
- * @returns {Promise<void>} automatically synchronized promise through #recorder
826
+ * @returns {void} automatically synchronized promise through #recorder
827
827
  *
828
828
  */
829
829
  async seeInField(field, value) {
@@ -842,7 +842,7 @@ class Protractor extends Helper {
842
842
  *
843
843
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
844
844
  * @param {CodeceptJS.StringOrSecret} value value to check.
845
- * @returns {Promise<void>} automatically synchronized promise through #recorder
845
+ * @returns {void} automatically synchronized promise through #recorder
846
846
  *
847
847
  */
848
848
  async dontSeeInField(field, value) {
@@ -861,7 +861,7 @@ class Protractor extends Helper {
861
861
  * ```
862
862
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
863
863
  * @param {string} value text value to append.
864
- * @returns {Promise<void>} automatically synchronized promise through #recorder
864
+ * @returns {void} automatically synchronized promise through #recorder
865
865
  *
866
866
  */
867
867
  async appendField(field, value) {
@@ -879,7 +879,7 @@ class Protractor extends Helper {
879
879
  * I.clearField('#email');
880
880
  * ```
881
881
  * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
882
- * @returns {Promise<void>} automatically synchronized promise through #recorder.
882
+ * @returns {void} automatically synchronized promise through #recorder.
883
883
  *
884
884
  */
885
885
  async clearField(field) {
@@ -901,7 +901,7 @@ class Protractor extends Helper {
901
901
  * ```
902
902
  * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
903
903
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
904
- * @returns {Promise<void>} automatically synchronized promise through #recorder
904
+ * @returns {void} automatically synchronized promise through #recorder
905
905
  *
906
906
  */
907
907
  async checkOption(field, context = null) {
@@ -930,7 +930,7 @@ class Protractor extends Helper {
930
930
  * ```
931
931
  * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
932
932
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
933
- * @returns {Promise<void>} automatically synchronized promise through #recorder
933
+ * @returns {void} automatically synchronized promise through #recorder
934
934
  *
935
935
  */
936
936
  async uncheckOption(field, context = null) {
@@ -956,7 +956,7 @@ class Protractor extends Helper {
956
956
  * ```
957
957
  *
958
958
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
959
- * @returns {Promise<void>} automatically synchronized promise through #recorder
959
+ * @returns {void} automatically synchronized promise through #recorder
960
960
  *
961
961
  */
962
962
  async seeCheckboxIsChecked(field) {
@@ -973,7 +973,7 @@ class Protractor extends Helper {
973
973
  * ```
974
974
  *
975
975
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
976
- * @returns {Promise<void>} automatically synchronized promise through #recorder
976
+ * @returns {void} automatically synchronized promise through #recorder
977
977
  *
978
978
  */
979
979
  async dontSeeCheckboxIsChecked(field) {
@@ -1208,7 +1208,7 @@ class Protractor extends Helper {
1208
1208
  * ```
1209
1209
  *
1210
1210
  * @param {string} text text value to check.
1211
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1211
+ * @returns {void} automatically synchronized promise through #recorder
1212
1212
  *
1213
1213
  */
1214
1214
  async seeInTitle(text) {
@@ -1223,7 +1223,7 @@ class Protractor extends Helper {
1223
1223
  * ```
1224
1224
  *
1225
1225
  * @param {string} text value to check.
1226
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1226
+ * @returns {void} automatically synchronized promise through #recorder
1227
1227
  *
1228
1228
  */
1229
1229
  async seeTitleEquals(text) {
@@ -1239,7 +1239,7 @@ class Protractor extends Helper {
1239
1239
  * ```
1240
1240
  *
1241
1241
  * @param {string} text value to check.
1242
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1242
+ * @returns {void} automatically synchronized promise through #recorder
1243
1243
  *
1244
1244
  */
1245
1245
  async dontSeeInTitle(text) {
@@ -1271,7 +1271,7 @@ class Protractor extends Helper {
1271
1271
  * I.seeElement('#modal');
1272
1272
  * ```
1273
1273
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1274
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1274
+ * @returns {void} automatically synchronized promise through #recorder
1275
1275
  *
1276
1276
  */
1277
1277
  async seeElement(locator) {
@@ -1288,7 +1288,7 @@ class Protractor extends Helper {
1288
1288
  * ```
1289
1289
  *
1290
1290
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
1291
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1291
+ * @returns {void} automatically synchronized promise through #recorder
1292
1292
  *
1293
1293
  */
1294
1294
  async dontSeeElement(locator) {
@@ -1305,7 +1305,7 @@ class Protractor extends Helper {
1305
1305
  * I.seeElementInDOM('#modal');
1306
1306
  * ```
1307
1307
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1308
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1308
+ * @returns {void} automatically synchronized promise through #recorder
1309
1309
  *
1310
1310
  */
1311
1311
  async seeElementInDOM(locator) {
@@ -1320,7 +1320,7 @@ class Protractor extends Helper {
1320
1320
  * ```
1321
1321
  *
1322
1322
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
1323
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1323
+ * @returns {void} automatically synchronized promise through #recorder
1324
1324
  *
1325
1325
  */
1326
1326
  async dontSeeElementInDOM(locator) {
@@ -1334,7 +1334,7 @@ class Protractor extends Helper {
1334
1334
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
1335
1335
  * ```
1336
1336
  * @param {string} text value to check.
1337
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1337
+ * @returns {void} automatically synchronized promise through #recorder
1338
1338
  *
1339
1339
  */
1340
1340
  async seeInSource(text) {
@@ -1363,7 +1363,7 @@ class Protractor extends Helper {
1363
1363
  * ```
1364
1364
  *
1365
1365
  * @param {string} value to check.
1366
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1366
+ * @returns {void} automatically synchronized promise through #recorder
1367
1367
  *
1368
1368
  */
1369
1369
  async dontSeeInSource(text) {
@@ -1381,7 +1381,7 @@ class Protractor extends Helper {
1381
1381
  *
1382
1382
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1383
1383
  * @param {number} num number of elements.
1384
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1384
+ * @returns {void} automatically synchronized promise through #recorder
1385
1385
  *
1386
1386
  */
1387
1387
  async seeNumberOfElements(locator, num) {
@@ -1399,7 +1399,7 @@ class Protractor extends Helper {
1399
1399
  *
1400
1400
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1401
1401
  * @param {number} num number of elements.
1402
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1402
+ * @returns {void} automatically synchronized promise through #recorder
1403
1403
  *
1404
1404
  */
1405
1405
  async seeNumberOfVisibleElements(locator, num) {
@@ -1433,7 +1433,7 @@ class Protractor extends Helper {
1433
1433
  *
1434
1434
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1435
1435
  * @param {object} cssProperties object with CSS properties and their values to check.
1436
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1436
+ * @returns {void} automatically synchronized promise through #recorder
1437
1437
  *
1438
1438
  */
1439
1439
  async seeCssPropertiesOnElements(locator, cssProperties) {
@@ -1473,7 +1473,7 @@ class Protractor extends Helper {
1473
1473
  *
1474
1474
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1475
1475
  * @param {object} attributes attributes and their values to check.
1476
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1476
+ * @returns {void} automatically synchronized promise through #recorder
1477
1477
  *
1478
1478
  */
1479
1479
  async seeAttributesOnElements(locator, attributes) {
@@ -1573,7 +1573,7 @@ class Protractor extends Helper {
1573
1573
  * ```
1574
1574
  *
1575
1575
  * @param {string} url a fragment to check
1576
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1576
+ * @returns {void} automatically synchronized promise through #recorder
1577
1577
  *
1578
1578
  */
1579
1579
  async seeInCurrentUrl(url) {
@@ -1584,7 +1584,7 @@ class Protractor extends Helper {
1584
1584
  * Checks that current url does not contain a provided fragment.
1585
1585
  *
1586
1586
  * @param {string} url value to check.
1587
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1587
+ * @returns {void} automatically synchronized promise through #recorder
1588
1588
  *
1589
1589
  */
1590
1590
  async dontSeeInCurrentUrl(url) {
@@ -1602,7 +1602,7 @@ class Protractor extends Helper {
1602
1602
  * ```
1603
1603
  *
1604
1604
  * @param {string} url value to check.
1605
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1605
+ * @returns {void} automatically synchronized promise through #recorder
1606
1606
  *
1607
1607
  */
1608
1608
  async seeCurrentUrlEquals(url) {
@@ -1619,7 +1619,7 @@ class Protractor extends Helper {
1619
1619
  * ```
1620
1620
  *
1621
1621
  * @param {string} url value to check.
1622
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1622
+ * @returns {void} automatically synchronized promise through #recorder
1623
1623
  *
1624
1624
  */
1625
1625
  async dontSeeCurrentUrlEquals(url) {
@@ -1636,7 +1636,7 @@ class Protractor extends Helper {
1636
1636
  *
1637
1637
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1638
1638
  * @param {string} fileName file name to save.
1639
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1639
+ * @returns {void} automatically synchronized promise through #recorder
1640
1640
  *
1641
1641
  *
1642
1642
  */
@@ -1672,7 +1672,7 @@ class Protractor extends Helper {
1672
1672
  *
1673
1673
  * @param {string} fileName file name to save.
1674
1674
  * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
1675
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1675
+ * @returns {void} automatically synchronized promise through #recorder
1676
1676
  *
1677
1677
  */
1678
1678
  async saveScreenshot(fileName, fullPage = false) {
@@ -1711,11 +1711,10 @@ class Protractor extends Helper {
1711
1711
  *
1712
1712
  * ```js
1713
1713
  * I.clearCookie();
1714
- * I.clearCookie('test');
1714
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
1715
1715
  * ```
1716
1716
  *
1717
1717
  * @param {?string} [cookie=null] (optional, `null` by default) cookie name
1718
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1719
1718
  *
1720
1719
  */
1721
1720
  async clearCookie(cookie = null) {
@@ -1733,7 +1732,7 @@ class Protractor extends Helper {
1733
1732
  * ```
1734
1733
  *
1735
1734
  * @param {string} name cookie name.
1736
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1735
+ * @returns {void} automatically synchronized promise through #recorder
1737
1736
  *
1738
1737
  */
1739
1738
  async seeCookie(name) {
@@ -1748,7 +1747,7 @@ class Protractor extends Helper {
1748
1747
  * ```
1749
1748
  *
1750
1749
  * @param {string} name cookie name.
1751
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1750
+ * @returns {void} automatically synchronized promise through #recorder
1752
1751
  *
1753
1752
  */
1754
1753
  async dontSeeCookie(name) {
@@ -1800,7 +1799,7 @@ class Protractor extends Helper {
1800
1799
  * I.seeInPopup('Popup text');
1801
1800
  * ```
1802
1801
  * @param {string} text value to check.
1803
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1802
+ * @returns {void} automatically synchronized promise through #recorder
1804
1803
  *
1805
1804
  */
1806
1805
  async seeInPopup(text) {
@@ -1841,7 +1840,7 @@ class Protractor extends Helper {
1841
1840
  *
1842
1841
  * @param {number} width width in pixels or `maximize`.
1843
1842
  * @param {number} height height in pixels.
1844
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1843
+ * @returns {void} automatically synchronized promise through #recorder
1845
1844
  *
1846
1845
  */
1847
1846
  async resizeWindow(width, height) {
@@ -1861,7 +1860,7 @@ class Protractor extends Helper {
1861
1860
  *
1862
1861
  * @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
1863
1862
  * @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
1864
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1863
+ * @returns {void} automatically synchronized promise through #recorder
1865
1864
  *
1866
1865
  */
1867
1866
  async dragAndDrop(srcElement, destElement) {
@@ -2005,7 +2004,7 @@ class Protractor extends Helper {
2005
2004
  * ```
2006
2005
  *
2007
2006
  * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
2008
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2007
+ * @returns {void} automatically synchronized promise through #recorder
2009
2008
  *
2010
2009
  */
2011
2010
  async switchTo(locator) {
@@ -2029,7 +2028,7 @@ class Protractor extends Helper {
2029
2028
  * ```
2030
2029
  *
2031
2030
  * @param {number} sec number of second to wait.
2032
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2031
+ * @returns {void} automatically synchronized promise through #recorder
2033
2032
  *
2034
2033
  */
2035
2034
  wait(sec) {
@@ -2047,7 +2046,7 @@ class Protractor extends Helper {
2047
2046
  *
2048
2047
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2049
2048
  * @param {number} [sec] (optional, `1` by default) time in seconds to wait
2050
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2049
+ * @returns {void} automatically synchronized promise through #recorder
2051
2050
  *
2052
2051
  */
2053
2052
  async waitForElement(locator, sec = null) {
@@ -2073,7 +2072,7 @@ class Protractor extends Helper {
2073
2072
  *
2074
2073
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2075
2074
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2076
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2075
+ * @returns {void} automatically synchronized promise through #recorder
2077
2076
  *
2078
2077
  */
2079
2078
  async waitForDetached(locator, sec = null) {
@@ -2109,7 +2108,7 @@ class Protractor extends Helper {
2109
2108
  *
2110
2109
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2111
2110
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2112
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2111
+ * @returns {void} automatically synchronized promise through #recorder
2113
2112
  *
2114
2113
  */
2115
2114
  async waitForVisible(locator, sec = null) {
@@ -2128,7 +2127,7 @@ class Protractor extends Helper {
2128
2127
  *
2129
2128
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2130
2129
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2131
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2130
+ * @returns {void} automatically synchronized promise through #recorder
2132
2131
  *
2133
2132
  */
2134
2133
  async waitToHide(locator, sec = null) {
@@ -2145,7 +2144,7 @@ class Protractor extends Helper {
2145
2144
  *
2146
2145
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2147
2146
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2148
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2147
+ * @returns {void} automatically synchronized promise through #recorder
2149
2148
  *
2150
2149
  */
2151
2150
  async waitForInvisible(locator, sec = null) {
@@ -2171,7 +2170,7 @@ class Protractor extends Helper {
2171
2170
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2172
2171
  * @param {number} num number of elements.
2173
2172
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2174
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2173
+ * @returns {void} automatically synchronized promise through #recorder
2175
2174
  *
2176
2175
  */
2177
2176
  async waitNumberOfVisibleElements(locator, num, sec = null) {
@@ -2199,7 +2198,7 @@ class Protractor extends Helper {
2199
2198
  *
2200
2199
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2201
2200
  * @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
2202
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2201
+ * @returns {void} automatically synchronized promise through #recorder
2203
2202
  *
2204
2203
  */
2205
2204
  async waitForEnabled(locator, sec = null) {
@@ -2222,7 +2221,7 @@ class Protractor extends Helper {
2222
2221
  * @param {LocatorOrString} field input field.
2223
2222
  * @param {string }value expected value.
2224
2223
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2225
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2224
+ * @returns {void} automatically synchronized promise through #recorder
2226
2225
  *
2227
2226
  */
2228
2227
  async waitForValue(field, value, sec = null) {
@@ -2263,7 +2262,7 @@ class Protractor extends Helper {
2263
2262
  * @param {string|function} fn to be executed in browser context.
2264
2263
  * @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
2265
2264
  * @param {number} [sec] (optional, `1` by default) time in seconds to wait
2266
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2265
+ * @returns {void} automatically synchronized promise through #recorder
2267
2266
  *
2268
2267
  */
2269
2268
  async waitForFunction(fn, argsOrSec = null, sec = null) {
@@ -2289,7 +2288,7 @@ class Protractor extends Helper {
2289
2288
  *
2290
2289
  * @param {string} urlPart value to check.
2291
2290
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2292
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2291
+ * @returns {void} automatically synchronized promise through #recorder
2293
2292
  *
2294
2293
  */
2295
2294
  async waitInUrl(urlPart, sec = null) {
@@ -2317,7 +2316,7 @@ class Protractor extends Helper {
2317
2316
  *
2318
2317
  * @param {string} urlPart value to check.
2319
2318
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2320
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2319
+ * @returns {void} automatically synchronized promise through #recorder
2321
2320
  *
2322
2321
  */
2323
2322
  async waitUrlEquals(urlPart, sec = null) {
@@ -2352,7 +2351,7 @@ class Protractor extends Helper {
2352
2351
  * @param {string }text to wait for.
2353
2352
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2354
2353
  * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
2355
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2354
+ * @returns {void} automatically synchronized promise through #recorder
2356
2355
  *
2357
2356
  */
2358
2357
  async waitForText(text, sec = null, context = null) {
@@ -2379,7 +2378,7 @@ class Protractor extends Helper {
2379
2378
  * ```js
2380
2379
  * I.refreshPage();
2381
2380
  * ```
2382
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2381
+ * @returns {void} automatically synchronized promise through #recorder
2383
2382
  *
2384
2383
  */
2385
2384
  refreshPage() {
@@ -2406,7 +2405,7 @@ class Protractor extends Helper {
2406
2405
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
2407
2406
  * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
2408
2407
  * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
2409
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2408
+ * @returns {void} automatically synchronized promise through #recorder
2410
2409
  *
2411
2410
  */
2412
2411
  async scrollTo(locator, offsetX = 0, offsetY = 0) {
@@ -2439,7 +2438,7 @@ class Protractor extends Helper {
2439
2438
  * ```js
2440
2439
  * I.scrollPageToTop();
2441
2440
  * ```
2442
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2441
+ * @returns {void} automatically synchronized promise through #recorder
2443
2442
  *
2444
2443
  */
2445
2444
  async scrollPageToTop() {
@@ -2452,7 +2451,7 @@ class Protractor extends Helper {
2452
2451
  * ```js
2453
2452
  * I.scrollPageToBottom();
2454
2453
  * ```
2455
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2454
+ * @returns {void} automatically synchronized promise through #recorder
2456
2455
  *
2457
2456
  */
2458
2457
  async scrollPageToBottom() {
@@ -2538,7 +2537,7 @@ class Protractor extends Helper {
2538
2537
  * ```
2539
2538
  *
2540
2539
  * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
2541
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2540
+ * @returns {void} automatically synchronized promise through #recorder
2542
2541
  *
2543
2542
  */
2544
2543
  setCookie(cookie) {