codeceptjs 3.5.8 → 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 (107) hide show
  1. package/README.md +1 -1
  2. package/docs/build/Appium.js +18 -18
  3. package/docs/build/Nightmare.js +51 -52
  4. package/docs/build/Playwright.js +74 -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 -571
  10. package/docs/community-helpers.md +4 -8
  11. package/docs/examples.md +2 -8
  12. package/docs/helpers/Appium.md +18 -18
  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/Playwright.js +2 -2
  105. package/package.json +1 -1
  106. package/typings/promiseBasedTypes.d.ts +418 -1007
  107. package/typings/types.d.ts +418 -424
@@ -468,7 +468,7 @@ class Puppeteer extends Helper {
468
468
  * I.seeInPopup('Popup text');
469
469
  * ```
470
470
  * @param {string} text value to check.
471
- * @returns {Promise<void>} automatically synchronized promise through #recorder
471
+ * @returns {void} automatically synchronized promise through #recorder
472
472
  *
473
473
  */
474
474
  async seeInPopup(text) {
@@ -664,7 +664,7 @@ class Puppeteer extends Helper {
664
664
  * ```
665
665
  *
666
666
  * @param {string} url url path or global url.
667
- * @returns {Promise<void>} automatically synchronized promise through #recorder
667
+ * @returns {void} automatically synchronized promise through #recorder
668
668
  *
669
669
  */
670
670
  async amOnPage(url) {
@@ -708,7 +708,7 @@ class Puppeteer extends Helper {
708
708
  *
709
709
  * @param {number} width width in pixels or `maximize`.
710
710
  * @param {number} height height in pixels.
711
- * @returns {Promise<void>} automatically synchronized promise through #recorder
711
+ * @returns {void} automatically synchronized promise through #recorder
712
712
  *
713
713
  *
714
714
  * Unlike other drivers Puppeteer changes the size of a viewport, not the window!
@@ -754,7 +754,7 @@ class Puppeteer extends Helper {
754
754
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
755
755
  * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
756
756
  * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
757
- * @returns {Promise<void>} automatically synchronized promise through #recorder
757
+ * @returns {void} automatically synchronized promise through #recorder
758
758
  *
759
759
  * {{ react }}
760
760
  */
@@ -781,7 +781,7 @@ class Puppeteer extends Helper {
781
781
  *
782
782
  * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
783
783
  * @param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
784
- * @returns {Promise<void>} automatically synchronized promise through #recorder
784
+ * @returns {void} automatically synchronized promise through #recorder
785
785
  *
786
786
  *
787
787
  */
@@ -812,7 +812,7 @@ class Puppeteer extends Helper {
812
812
  *
813
813
  * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
814
814
  * @param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
815
- * @returns {Promise<void>} automatically synchronized promise through #recorder
815
+ * @returns {void} automatically synchronized promise through #recorder
816
816
  *
817
817
  *
818
818
  */
@@ -833,7 +833,7 @@ class Puppeteer extends Helper {
833
833
  *
834
834
  * @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
835
835
  * @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
836
- * @returns {Promise<void>} automatically synchronized promise through #recorder
836
+ * @returns {void} automatically synchronized promise through #recorder
837
837
  *
838
838
  */
839
839
  async dragAndDrop(srcElement, destElement) {
@@ -846,7 +846,7 @@ class Puppeteer extends Helper {
846
846
  * ```js
847
847
  * I.refreshPage();
848
848
  * ```
849
- * @returns {Promise<void>} automatically synchronized promise through #recorder
849
+ * @returns {void} automatically synchronized promise through #recorder
850
850
  *
851
851
  */
852
852
  async refreshPage() {
@@ -859,7 +859,7 @@ class Puppeteer extends Helper {
859
859
  * ```js
860
860
  * I.scrollPageToTop();
861
861
  * ```
862
- * @returns {Promise<void>} automatically synchronized promise through #recorder
862
+ * @returns {void} automatically synchronized promise through #recorder
863
863
  *
864
864
  */
865
865
  scrollPageToTop() {
@@ -874,7 +874,7 @@ class Puppeteer extends Helper {
874
874
  * ```js
875
875
  * I.scrollPageToBottom();
876
876
  * ```
877
- * @returns {Promise<void>} automatically synchronized promise through #recorder
877
+ * @returns {void} automatically synchronized promise through #recorder
878
878
  *
879
879
  */
880
880
  scrollPageToBottom() {
@@ -903,7 +903,7 @@ class Puppeteer extends Helper {
903
903
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
904
904
  * @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
905
905
  * @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
906
- * @returns {Promise<void>} automatically synchronized promise through #recorder
906
+ * @returns {void} automatically synchronized promise through #recorder
907
907
  *
908
908
  */
909
909
  async scrollTo(locator, offsetX = 0, offsetY = 0) {
@@ -934,7 +934,7 @@ class Puppeteer extends Helper {
934
934
  * ```
935
935
  *
936
936
  * @param {string} text text value to check.
937
- * @returns {Promise<void>} automatically synchronized promise through #recorder
937
+ * @returns {void} automatically synchronized promise through #recorder
938
938
  *
939
939
  */
940
940
  async seeInTitle(text) {
@@ -973,7 +973,7 @@ class Puppeteer extends Helper {
973
973
  * ```
974
974
  *
975
975
  * @param {string} text value to check.
976
- * @returns {Promise<void>} automatically synchronized promise through #recorder
976
+ * @returns {void} automatically synchronized promise through #recorder
977
977
  *
978
978
  */
979
979
  async seeTitleEquals(text) {
@@ -989,7 +989,7 @@ class Puppeteer extends Helper {
989
989
  * ```
990
990
  *
991
991
  * @param {string} text value to check.
992
- * @returns {Promise<void>} automatically synchronized promise through #recorder
992
+ * @returns {void} automatically synchronized promise through #recorder
993
993
  *
994
994
  */
995
995
  async dontSeeInTitle(text) {
@@ -1179,7 +1179,7 @@ class Puppeteer extends Helper {
1179
1179
  * I.seeElement('#modal');
1180
1180
  * ```
1181
1181
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
1182
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1182
+ * @returns {void} automatically synchronized promise through #recorder
1183
1183
  *
1184
1184
  * {{ react }}
1185
1185
  */
@@ -1200,7 +1200,7 @@ class Puppeteer extends Helper {
1200
1200
  * ```
1201
1201
  *
1202
1202
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
1203
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1203
+ * @returns {void} automatically synchronized promise through #recorder
1204
1204
  *
1205
1205
  * {{ react }}
1206
1206
  */
@@ -1221,7 +1221,7 @@ class Puppeteer extends Helper {
1221
1221
  * I.seeElementInDOM('#modal');
1222
1222
  * ```
1223
1223
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1224
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1224
+ * @returns {void} automatically synchronized promise through #recorder
1225
1225
  *
1226
1226
  */
1227
1227
  async seeElementInDOM(locator) {
@@ -1237,7 +1237,7 @@ class Puppeteer extends Helper {
1237
1237
  * ```
1238
1238
  *
1239
1239
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
1240
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1240
+ * @returns {void} automatically synchronized promise through #recorder
1241
1241
  *
1242
1242
  */
1243
1243
  async dontSeeElementInDOM(locator) {
@@ -1270,7 +1270,7 @@ class Puppeteer extends Helper {
1270
1270
  *
1271
1271
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1272
1272
  * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1273
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1273
+ * @returns {void} automatically synchronized promise through #recorder
1274
1274
  *
1275
1275
  *
1276
1276
  * {{ react }}
@@ -1307,7 +1307,7 @@ class Puppeteer extends Helper {
1307
1307
  *
1308
1308
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1309
1309
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1310
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1310
+ * @returns {void} automatically synchronized promise through #recorder
1311
1311
  *
1312
1312
  *
1313
1313
  * {{ react }}
@@ -1345,7 +1345,7 @@ class Puppeteer extends Helper {
1345
1345
  * ```
1346
1346
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
1347
1347
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
1348
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1348
+ * @returns {void} automatically synchronized promise through #recorder
1349
1349
  *
1350
1350
  *
1351
1351
  * {{ react }}
@@ -1464,7 +1464,7 @@ class Puppeteer extends Helper {
1464
1464
  *
1465
1465
  * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1466
1466
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1467
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1467
+ * @returns {void} automatically synchronized promise through #recorder
1468
1468
  *
1469
1469
  *
1470
1470
  * {{ react }}
@@ -1487,7 +1487,7 @@ class Puppeteer extends Helper {
1487
1487
  *
1488
1488
  * @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
1489
1489
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
1490
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1490
+ * @returns {void} automatically synchronized promise through #recorder
1491
1491
  *
1492
1492
  *
1493
1493
  * {{ react }}
@@ -1509,7 +1509,7 @@ class Puppeteer extends Helper {
1509
1509
  * ```
1510
1510
  * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
1511
1511
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
1512
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1512
+ * @returns {void} automatically synchronized promise through #recorder
1513
1513
  *
1514
1514
  */
1515
1515
  async checkOption(field, context = null) {
@@ -1536,7 +1536,7 @@ class Puppeteer extends Helper {
1536
1536
  * ```
1537
1537
  * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
1538
1538
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
1539
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1539
+ * @returns {void} automatically synchronized promise through #recorder
1540
1540
  *
1541
1541
  */
1542
1542
  async uncheckOption(field, context = null) {
@@ -1560,7 +1560,7 @@ class Puppeteer extends Helper {
1560
1560
  * ```
1561
1561
  *
1562
1562
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1563
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1563
+ * @returns {void} automatically synchronized promise through #recorder
1564
1564
  *
1565
1565
  */
1566
1566
  async seeCheckboxIsChecked(field) {
@@ -1577,7 +1577,7 @@ class Puppeteer extends Helper {
1577
1577
  * ```
1578
1578
  *
1579
1579
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1580
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1580
+ * @returns {void} automatically synchronized promise through #recorder
1581
1581
  *
1582
1582
  */
1583
1583
  async dontSeeCheckboxIsChecked(field) {
@@ -1596,7 +1596,7 @@ class Puppeteer extends Helper {
1596
1596
  * ```
1597
1597
  *
1598
1598
  * @param {string} key name of key to press down.
1599
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1599
+ * @returns {void} automatically synchronized promise through #recorder
1600
1600
  *
1601
1601
  */
1602
1602
  async pressKeyDown(key) {
@@ -1617,7 +1617,7 @@ class Puppeteer extends Helper {
1617
1617
  * ```
1618
1618
  *
1619
1619
  * @param {string} key name of key to release.
1620
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1620
+ * @returns {void} automatically synchronized promise through #recorder
1621
1621
  *
1622
1622
  */
1623
1623
  async pressKeyUp(key) {
@@ -1686,7 +1686,7 @@ class Puppeteer extends Helper {
1686
1686
  * - `'Tab'`
1687
1687
  *
1688
1688
  * @param {string|string[]} key key or array of keys to press.
1689
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1689
+ * @returns {void} automatically synchronized promise through #recorder
1690
1690
  *
1691
1691
  *
1692
1692
  * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
@@ -1737,7 +1737,7 @@ class Puppeteer extends Helper {
1737
1737
  *
1738
1738
  * @param {string|string[]} key or array of keys to type.
1739
1739
  * @param {?number} [delay=null] (optional) delay in ms between key presses
1740
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1740
+ * @returns {void} automatically synchronized promise through #recorder
1741
1741
  *
1742
1742
  */
1743
1743
  async type(keys, delay = null) {
@@ -1768,7 +1768,7 @@ class Puppeteer extends Helper {
1768
1768
  * ```
1769
1769
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1770
1770
  * @param {CodeceptJS.StringOrSecret} value text value to fill.
1771
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1771
+ * @returns {void} automatically synchronized promise through #recorder
1772
1772
  *
1773
1773
  * {{ react }}
1774
1774
  */
@@ -1799,7 +1799,7 @@ class Puppeteer extends Helper {
1799
1799
  * I.clearField('#email');
1800
1800
  * ```
1801
1801
  * @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
1802
- * @returns {Promise<void>} automatically synchronized promise through #recorder.
1802
+ * @returns {void} automatically synchronized promise through #recorder.
1803
1803
  *
1804
1804
  */
1805
1805
  async clearField(field) {
@@ -1817,7 +1817,7 @@ class Puppeteer extends Helper {
1817
1817
  * ```
1818
1818
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
1819
1819
  * @param {string} value text value to append.
1820
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1820
+ * @returns {void} automatically synchronized promise through #recorder
1821
1821
  *
1822
1822
  *
1823
1823
  * {{ react }}
@@ -1843,7 +1843,7 @@ class Puppeteer extends Helper {
1843
1843
  * ```
1844
1844
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1845
1845
  * @param {CodeceptJS.StringOrSecret} value value to check.
1846
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1846
+ * @returns {void} automatically synchronized promise through #recorder
1847
1847
  *
1848
1848
  */
1849
1849
  async seeInField(field, value) {
@@ -1862,7 +1862,7 @@ class Puppeteer extends Helper {
1862
1862
  *
1863
1863
  * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
1864
1864
  * @param {CodeceptJS.StringOrSecret} value value to check.
1865
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1865
+ * @returns {void} automatically synchronized promise through #recorder
1866
1866
  *
1867
1867
  */
1868
1868
  async dontSeeInField(field, value) {
@@ -1882,7 +1882,7 @@ class Puppeteer extends Helper {
1882
1882
  *
1883
1883
  * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
1884
1884
  * @param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
1885
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1885
+ * @returns {void} automatically synchronized promise through #recorder
1886
1886
  *
1887
1887
  *
1888
1888
  * > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1](https://github.com/puppeteer/puppeteer/issues/5420), downgrade to 2.0.0 if you face it.
@@ -1920,7 +1920,7 @@ class Puppeteer extends Helper {
1920
1920
  * ```
1921
1921
  * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
1922
1922
  * @param {string|Array<*>} option visible text or value of option.
1923
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1923
+ * @returns {void} automatically synchronized promise through #recorder
1924
1924
  *
1925
1925
  */
1926
1926
  async selectOption(select, option) {
@@ -1982,7 +1982,7 @@ class Puppeteer extends Helper {
1982
1982
  * ```
1983
1983
  *
1984
1984
  * @param {string} url a fragment to check
1985
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1985
+ * @returns {void} automatically synchronized promise through #recorder
1986
1986
  *
1987
1987
  */
1988
1988
  async seeInCurrentUrl(url) {
@@ -1993,7 +1993,7 @@ class Puppeteer extends Helper {
1993
1993
  * Checks that current url does not contain a provided fragment.
1994
1994
  *
1995
1995
  * @param {string} url value to check.
1996
- * @returns {Promise<void>} automatically synchronized promise through #recorder
1996
+ * @returns {void} automatically synchronized promise through #recorder
1997
1997
  *
1998
1998
  */
1999
1999
  async dontSeeInCurrentUrl(url) {
@@ -2011,7 +2011,7 @@ class Puppeteer extends Helper {
2011
2011
  * ```
2012
2012
  *
2013
2013
  * @param {string} url value to check.
2014
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2014
+ * @returns {void} automatically synchronized promise through #recorder
2015
2015
  *
2016
2016
  */
2017
2017
  async seeCurrentUrlEquals(url) {
@@ -2028,7 +2028,7 @@ class Puppeteer extends Helper {
2028
2028
  * ```
2029
2029
  *
2030
2030
  * @param {string} url value to check.
2031
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2031
+ * @returns {void} automatically synchronized promise through #recorder
2032
2032
  *
2033
2033
  */
2034
2034
  async dontSeeCurrentUrlEquals(url) {
@@ -2046,7 +2046,7 @@ class Puppeteer extends Helper {
2046
2046
  * ```
2047
2047
  * @param {string} text expected on page.
2048
2048
  * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
2049
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2049
+ * @returns {void} automatically synchronized promise through #recorder
2050
2050
  *
2051
2051
  *
2052
2052
  * {{ react }}
@@ -2064,7 +2064,7 @@ class Puppeteer extends Helper {
2064
2064
  *
2065
2065
  * @param {string} text element value to check.
2066
2066
  * @param {CodeceptJS.LocatorOrString?} [context=null] element located by CSS|XPath|strict locator.
2067
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2067
+ * @returns {void} automatically synchronized promise through #recorder
2068
2068
  *
2069
2069
  */
2070
2070
  async seeTextEquals(text, context = null) {
@@ -2082,7 +2082,7 @@ class Puppeteer extends Helper {
2082
2082
  *
2083
2083
  * @param {string} text which is not present.
2084
2084
  * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
2085
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2085
+ * @returns {void} automatically synchronized promise through #recorder
2086
2086
  *
2087
2087
  *
2088
2088
  * {{ react }}
@@ -2142,7 +2142,7 @@ class Puppeteer extends Helper {
2142
2142
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
2143
2143
  * ```
2144
2144
  * @param {string} text value to check.
2145
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2145
+ * @returns {void} automatically synchronized promise through #recorder
2146
2146
  *
2147
2147
  */
2148
2148
  async seeInSource(text) {
@@ -2158,7 +2158,7 @@ class Puppeteer extends Helper {
2158
2158
  * ```
2159
2159
  *
2160
2160
  * @param {string} value to check.
2161
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2161
+ * @returns {void} automatically synchronized promise through #recorder
2162
2162
  *
2163
2163
  */
2164
2164
  async dontSeeInSource(text) {
@@ -2177,7 +2177,7 @@ class Puppeteer extends Helper {
2177
2177
  *
2178
2178
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2179
2179
  * @param {number} num number of elements.
2180
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2180
+ * @returns {void} automatically synchronized promise through #recorder
2181
2181
  *
2182
2182
  *
2183
2183
  * {{ react }}
@@ -2197,7 +2197,7 @@ class Puppeteer extends Helper {
2197
2197
  *
2198
2198
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2199
2199
  * @param {number} num number of elements.
2200
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2200
+ * @returns {void} automatically synchronized promise through #recorder
2201
2201
  *
2202
2202
  *
2203
2203
  * {{ react }}
@@ -2223,7 +2223,7 @@ class Puppeteer extends Helper {
2223
2223
  * ```
2224
2224
  *
2225
2225
  * @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
2226
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2226
+ * @returns {void} automatically synchronized promise through #recorder
2227
2227
  *
2228
2228
  */
2229
2229
  async setCookie(cookie) {
@@ -2241,7 +2241,7 @@ class Puppeteer extends Helper {
2241
2241
  * ```
2242
2242
  *
2243
2243
  * @param {string} name cookie name.
2244
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2244
+ * @returns {void} automatically synchronized promise through #recorder
2245
2245
  *
2246
2246
  *
2247
2247
  */
@@ -2258,7 +2258,7 @@ class Puppeteer extends Helper {
2258
2258
  * ```
2259
2259
  *
2260
2260
  * @param {string} name cookie name.
2261
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2261
+ * @returns {void} automatically synchronized promise through #recorder
2262
2262
  *
2263
2263
  */
2264
2264
  async dontSeeCookie(name) {
@@ -2295,11 +2295,10 @@ class Puppeteer extends Helper {
2295
2295
  *
2296
2296
  * ```js
2297
2297
  * I.clearCookie();
2298
- * I.clearCookie('test');
2298
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
2299
2299
  * ```
2300
2300
  *
2301
2301
  * @param {?string} [cookie=null] (optional, `null` by default) cookie name
2302
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2303
2302
  *
2304
2303
  */
2305
2304
  async clearCookie(name) {
@@ -2580,7 +2579,7 @@ class Puppeteer extends Helper {
2580
2579
  *
2581
2580
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
2582
2581
  * @param {object} cssProperties object with CSS properties and their values to check.
2583
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2582
+ * @returns {void} automatically synchronized promise through #recorder
2584
2583
  *
2585
2584
  * {{ react }}
2586
2585
  */
@@ -2628,7 +2627,7 @@ class Puppeteer extends Helper {
2628
2627
  *
2629
2628
  * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
2630
2629
  * @param {object} attributes attributes and their values to check.
2631
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2630
+ * @returns {void} automatically synchronized promise through #recorder
2632
2631
  *
2633
2632
  * {{ react }}
2634
2633
  */
@@ -2670,7 +2669,7 @@ class Puppeteer extends Helper {
2670
2669
  *
2671
2670
  * @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
2672
2671
  * @param {number} offsetX position to drag.
2673
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2672
+ * @returns {void} automatically synchronized promise through #recorder
2674
2673
  *
2675
2674
  * {{ react }}
2676
2675
  */
@@ -2749,7 +2748,7 @@ class Puppeteer extends Helper {
2749
2748
  *
2750
2749
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2751
2750
  * @param {string} fileName file name to save.
2752
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2751
+ * @returns {void} automatically synchronized promise through #recorder
2753
2752
  *
2754
2753
  */
2755
2754
  async saveElementScreenshot(locator, fileName) {
@@ -2775,7 +2774,7 @@ class Puppeteer extends Helper {
2775
2774
  *
2776
2775
  * @param {string} fileName file name to save.
2777
2776
  * @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
2778
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2777
+ * @returns {void} automatically synchronized promise through #recorder
2779
2778
  *
2780
2779
  */
2781
2780
  async saveScreenshot(fileName, fullPage) {
@@ -2842,7 +2841,7 @@ class Puppeteer extends Helper {
2842
2841
  * ```
2843
2842
  *
2844
2843
  * @param {number} sec number of second to wait.
2845
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2844
+ * @returns {void} automatically synchronized promise through #recorder
2846
2845
  *
2847
2846
  */
2848
2847
  async wait(sec) {
@@ -2857,7 +2856,7 @@ class Puppeteer extends Helper {
2857
2856
  *
2858
2857
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2859
2858
  * @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
2860
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2859
+ * @returns {void} automatically synchronized promise through #recorder
2861
2860
  *
2862
2861
  */
2863
2862
  async waitForEnabled(locator, sec) {
@@ -2897,7 +2896,7 @@ class Puppeteer extends Helper {
2897
2896
  * @param {LocatorOrString} field input field.
2898
2897
  * @param {string }value expected value.
2899
2898
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2900
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2899
+ * @returns {void} automatically synchronized promise through #recorder
2901
2900
  *
2902
2901
  */
2903
2902
  async waitForValue(field, value, sec) {
@@ -2938,7 +2937,7 @@ class Puppeteer extends Helper {
2938
2937
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2939
2938
  * @param {number} num number of elements.
2940
2939
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
2941
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2940
+ * @returns {void} automatically synchronized promise through #recorder
2942
2941
  *
2943
2942
  * {{ react }}
2944
2943
  */
@@ -2980,7 +2979,7 @@ class Puppeteer extends Helper {
2980
2979
  *
2981
2980
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
2982
2981
  * @param {number} [sec] (optional, `1` by default) time in seconds to wait
2983
- * @returns {Promise<void>} automatically synchronized promise through #recorder
2982
+ * @returns {void} automatically synchronized promise through #recorder
2984
2983
  *
2985
2984
  */
2986
2985
  async waitForClickable(locator, waitTimeout) {
@@ -3007,7 +3006,7 @@ class Puppeteer extends Helper {
3007
3006
  *
3008
3007
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
3009
3008
  * @param {number} [sec] (optional, `1` by default) time in seconds to wait
3010
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3009
+ * @returns {void} automatically synchronized promise through #recorder
3011
3010
  *
3012
3011
  * {{ react }}
3013
3012
  */
@@ -3037,7 +3036,7 @@ class Puppeteer extends Helper {
3037
3036
  *
3038
3037
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
3039
3038
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3040
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3039
+ * @returns {void} automatically synchronized promise through #recorder
3041
3040
  *
3042
3041
  *
3043
3042
  * This method accepts [React selectors](https://codecept.io/react).
@@ -3068,7 +3067,7 @@ class Puppeteer extends Helper {
3068
3067
  *
3069
3068
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
3070
3069
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3071
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3070
+ * @returns {void} automatically synchronized promise through #recorder
3072
3071
  *
3073
3072
  */
3074
3073
  async waitForInvisible(locator, sec) {
@@ -3097,7 +3096,7 @@ class Puppeteer extends Helper {
3097
3096
  *
3098
3097
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
3099
3098
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3100
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3099
+ * @returns {void} automatically synchronized promise through #recorder
3101
3100
  *
3102
3101
  */
3103
3102
  async waitToHide(locator, sec) {
@@ -3131,7 +3130,7 @@ class Puppeteer extends Helper {
3131
3130
  *
3132
3131
  * @param {string} urlPart value to check.
3133
3132
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3134
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3133
+ * @returns {void} automatically synchronized promise through #recorder
3135
3134
  *
3136
3135
  */
3137
3136
  async waitInUrl(urlPart, sec = null) {
@@ -3160,7 +3159,7 @@ class Puppeteer extends Helper {
3160
3159
  *
3161
3160
  * @param {string} urlPart value to check.
3162
3161
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3163
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3162
+ * @returns {void} automatically synchronized promise through #recorder
3164
3163
  *
3165
3164
  */
3166
3165
  async waitUrlEquals(urlPart, sec = null) {
@@ -3197,7 +3196,7 @@ class Puppeteer extends Helper {
3197
3196
  * @param {string }text to wait for.
3198
3197
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3199
3198
  * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
3200
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3199
+ * @returns {void} automatically synchronized promise through #recorder
3201
3200
  *
3202
3201
  */
3203
3202
  async waitForText(text, sec = null, context = null) {
@@ -3274,7 +3273,7 @@ class Puppeteer extends Helper {
3274
3273
  * ```
3275
3274
  *
3276
3275
  * @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
3277
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3276
+ * @returns {void} automatically synchronized promise through #recorder
3278
3277
  *
3279
3278
  */
3280
3279
  async switchTo(locator) {
@@ -3329,7 +3328,7 @@ class Puppeteer extends Helper {
3329
3328
  * @param {string|function} fn to be executed in browser context.
3330
3329
  * @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
3331
3330
  * @param {number} [sec] (optional, `1` by default) time in seconds to wait
3332
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3331
+ * @returns {void} automatically synchronized promise through #recorder
3333
3332
  *
3334
3333
  */
3335
3334
  async waitForFunction(fn, argsOrSec = null, sec = null) {
@@ -3379,7 +3378,7 @@ class Puppeteer extends Helper {
3379
3378
  *
3380
3379
  * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
3381
3380
  * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
3382
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3381
+ * @returns {void} automatically synchronized promise through #recorder
3383
3382
  *
3384
3383
  */
3385
3384
  async waitForDetached(locator, sec) {
@@ -3429,7 +3428,7 @@ class Puppeteer extends Helper {
3429
3428
  * loadEventEnd: 241
3430
3429
  * }
3431
3430
  * ```
3432
- * @returns {Promise<void>} automatically synchronized promise through #recorder
3431
+ * @returns {void} automatically synchronized promise through #recorder
3433
3432
  *
3434
3433
  */
3435
3434
  async grabDataFromPerformanceTiming() {