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
@@ -889,7 +889,7 @@ I.appendField('password', secret('123456'));
889
889
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator
890
890
  - `value` **[string][5]** text value to append.
891
891
 
892
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
892
+ Returns **void** automatically synchronized promise through #recorder
893
893
 
894
894
  ### checkOption
895
895
 
@@ -909,7 +909,7 @@ I.checkOption('agree', '//form');
909
909
  - `field` **([string][5] \| [object][11])** checkbox located by label | name | CSS | XPath | strict locator.
910
910
  - `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`)
911
911
 
912
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
912
+ Returns **void** automatically synchronized promise through #recorder
913
913
 
914
914
  ### click
915
915
 
@@ -940,7 +940,7 @@ I.click({css: 'nav a.login'});
940
940
  - `locator` **([string][5] \| [object][11])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
941
941
  - `context` **([string][5]? | [object][11] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`)
942
942
 
943
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
943
+ Returns **void** automatically synchronized promise through #recorder
944
944
 
945
945
  ### dontSeeCheckboxIsChecked
946
946
 
@@ -956,7 +956,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
956
956
 
957
957
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator.
958
958
 
959
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
959
+ Returns **void** automatically synchronized promise through #recorder
960
960
 
961
961
  ### dontSeeElement
962
962
 
@@ -970,7 +970,7 @@ I.dontSeeElement('.modal'); // modal is not shown
970
970
 
971
971
  - `locator` **([string][5] \| [object][11])** located by CSS|XPath|Strict locator.
972
972
 
973
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
973
+ Returns **void** automatically synchronized promise through #recorder
974
974
 
975
975
  ### dontSeeInField
976
976
 
@@ -987,7 +987,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
987
987
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator.
988
988
  - `value` **([string][5] \| [object][11])** value to check.
989
989
 
990
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
990
+ Returns **void** automatically synchronized promise through #recorder
991
991
 
992
992
  ### dontSee
993
993
 
@@ -1004,7 +1004,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
1004
1004
  - `text` **[string][5]** which is not present.
1005
1005
  - `context` **([string][5] \| [object][11])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. (optional, default `null`)
1006
1006
 
1007
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1007
+ Returns **void** automatically synchronized promise through #recorder
1008
1008
 
1009
1009
  ### fillField
1010
1010
 
@@ -1027,7 +1027,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
1027
1027
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator.
1028
1028
  - `value` **([string][5] \| [object][11])** text value to fill.
1029
1029
 
1030
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1030
+ Returns **void** automatically synchronized promise through #recorder
1031
1031
 
1032
1032
  ### grabTextFromAll
1033
1033
 
@@ -1173,7 +1173,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
1173
1173
  - `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator.
1174
1174
  - `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].
1175
1175
 
1176
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing
1176
+ Returns **void** automatically synchronized promise through #recorderSupported only for web testing
1177
1177
 
1178
1178
  ### seeCheckboxIsChecked
1179
1179
 
@@ -1189,7 +1189,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
1189
1189
 
1190
1190
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator.
1191
1191
 
1192
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1192
+ Returns **void** automatically synchronized promise through #recorder
1193
1193
 
1194
1194
  ### seeElement
1195
1195
 
@@ -1204,7 +1204,7 @@ I.seeElement('#modal');
1204
1204
 
1205
1205
  - `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator.
1206
1206
 
1207
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1207
+ Returns **void** automatically synchronized promise through #recorder
1208
1208
 
1209
1209
  ### seeInField
1210
1210
 
@@ -1223,7 +1223,7 @@ I.seeInField('#searchform input','Search');
1223
1223
  - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator.
1224
1224
  - `value` **([string][5] \| [object][11])** value to check.
1225
1225
 
1226
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1226
+ Returns **void** automatically synchronized promise through #recorder
1227
1227
 
1228
1228
  ### see
1229
1229
 
@@ -1241,7 +1241,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
1241
1241
  - `text` **[string][5]** expected on page.
1242
1242
  - `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. (optional, default `null`)
1243
1243
 
1244
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1244
+ Returns **void** automatically synchronized promise through #recorder
1245
1245
 
1246
1246
  ### selectOption
1247
1247
 
@@ -1269,7 +1269,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
1269
1269
  - `select` **([string][5] \| [object][11])** field located by label|name|CSS|XPath|strict locator.
1270
1270
  - `option` **([string][5] \| [Array][8]<any>)** visible text or value of option.
1271
1271
 
1272
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing
1272
+ Returns **void** automatically synchronized promise through #recorderSupported only for web testing
1273
1273
 
1274
1274
  ### waitForElement
1275
1275
 
@@ -1286,7 +1286,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
1286
1286
  - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator.
1287
1287
  - `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait (optional, default `null`)
1288
1288
 
1289
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1289
+ Returns **void** automatically synchronized promise through #recorder
1290
1290
 
1291
1291
  ### waitForVisible
1292
1292
 
@@ -1302,7 +1302,7 @@ I.waitForVisible('#popup');
1302
1302
  - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator.
1303
1303
  - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1304
1304
 
1305
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1305
+ Returns **void** automatically synchronized promise through #recorder
1306
1306
 
1307
1307
  ### waitForInvisible
1308
1308
 
@@ -1318,7 +1318,7 @@ I.waitForInvisible('#popup');
1318
1318
  - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator.
1319
1319
  - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1320
1320
 
1321
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1321
+ Returns **void** automatically synchronized promise through #recorder
1322
1322
 
1323
1323
  ### waitForText
1324
1324
 
@@ -1337,7 +1337,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
1337
1337
  - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
1338
1338
  - `context` **([string][5] \| [object][11])?** (optional) element located by CSS|XPath|strict locator. (optional, default `null`)
1339
1339
 
1340
- Returns **[Promise][6]<void>** automatically synchronized promise through #recorder
1340
+ Returns **void** automatically synchronized promise through #recorder
1341
1341
 
1342
1342
  [1]: http://codecept.io/helpers/WebDriver/
1343
1343