codeceptjs 3.5.0 → 3.5.1-2.beta.7

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 (273) hide show
  1. package/README.md +24 -25
  2. package/lib/actor.js +6 -3
  3. package/lib/ai.js +12 -3
  4. package/lib/cli.js +12 -2
  5. package/lib/codecept.js +4 -0
  6. package/lib/colorUtils.js +10 -0
  7. package/lib/command/definitions.js +2 -7
  8. package/lib/command/dryRun.js +2 -1
  9. package/lib/command/info.js +24 -0
  10. package/lib/command/init.js +51 -5
  11. package/lib/command/run-multiple/collection.js +17 -5
  12. package/lib/command/run-multiple.js +4 -2
  13. package/lib/command/run-workers.js +66 -4
  14. package/lib/command/run.js +7 -0
  15. package/lib/command/workers/runTests.js +39 -0
  16. package/lib/data/context.js +14 -6
  17. package/lib/event.js +4 -0
  18. package/lib/helper/ApiDataFactory.js +2 -1
  19. package/lib/helper/Appium.js +73 -24
  20. package/lib/helper/Expect.js +422 -0
  21. package/lib/helper/FileSystem.js +1 -1
  22. package/lib/helper/GraphQL.js +25 -0
  23. package/lib/helper/Nightmare.js +9 -4
  24. package/lib/helper/OpenAI.js +14 -10
  25. package/lib/helper/Playwright.js +1205 -288
  26. package/lib/helper/Protractor.js +11 -6
  27. package/lib/helper/Puppeteer.js +173 -61
  28. package/lib/helper/TestCafe.js +44 -9
  29. package/lib/helper/WebDriver.js +231 -82
  30. package/lib/helper/errors/ElementNotFound.js +2 -1
  31. package/lib/helper/extras/PlaywrightReactVueLocator.js +38 -0
  32. package/lib/helper/scripts/blurElement.js +17 -0
  33. package/lib/helper/scripts/focusElement.js +17 -0
  34. package/lib/helper/scripts/highlightElement.js +2 -2
  35. package/lib/html.js +3 -3
  36. package/lib/interfaces/bdd.js +1 -1
  37. package/lib/interfaces/gherkin.js +37 -3
  38. package/lib/interfaces/scenarioConfig.js +1 -0
  39. package/lib/locator.js +17 -4
  40. package/lib/mochaFactory.js +2 -1
  41. package/lib/output.js +1 -1
  42. package/lib/pause.js +12 -9
  43. package/lib/plugin/autoLogin.js +45 -10
  44. package/lib/plugin/heal.js +47 -17
  45. package/lib/plugin/retryFailedStep.js +10 -1
  46. package/lib/plugin/retryTo.js +2 -4
  47. package/lib/plugin/selenoid.js +6 -1
  48. package/lib/plugin/standardActingHelpers.js +0 -2
  49. package/lib/plugin/stepByStepReport.js +2 -2
  50. package/lib/plugin/tryTo.js +5 -7
  51. package/lib/plugin/wdio.js +0 -1
  52. package/lib/recorder.js +20 -9
  53. package/lib/session.js +1 -1
  54. package/lib/step.js +30 -11
  55. package/lib/ui.js +1 -0
  56. package/lib/utils.js +18 -1
  57. package/lib/workers.js +28 -3
  58. package/package.json +108 -98
  59. package/translations/de-DE.js +5 -0
  60. package/translations/fr-FR.js +14 -1
  61. package/translations/it-IT.js +1 -0
  62. package/translations/ja-JP.js +5 -0
  63. package/translations/pl-PL.js +5 -0
  64. package/translations/pt-BR.js +1 -0
  65. package/translations/ru-RU.js +1 -0
  66. package/translations/zh-CN.js +5 -0
  67. package/translations/zh-TW.js +5 -0
  68. package/typings/index.d.ts +8 -6
  69. package/typings/promiseBasedTypes.d.ts +784 -822
  70. package/typings/types.d.ts +1214 -727
  71. package/CHANGELOG.md +0 -2492
  72. package/docs/advanced.md +0 -351
  73. package/docs/ai.md +0 -246
  74. package/docs/api.md +0 -323
  75. package/docs/basics.md +0 -980
  76. package/docs/bdd.md +0 -535
  77. package/docs/best.md +0 -237
  78. package/docs/books.md +0 -37
  79. package/docs/bootstrap.md +0 -135
  80. package/docs/build/ApiDataFactory.js +0 -409
  81. package/docs/build/Appium.js +0 -1978
  82. package/docs/build/FileSystem.js +0 -228
  83. package/docs/build/GraphQL.js +0 -204
  84. package/docs/build/GraphQLDataFactory.js +0 -309
  85. package/docs/build/JSONResponse.js +0 -338
  86. package/docs/build/Mochawesome.js +0 -71
  87. package/docs/build/Nightmare.js +0 -2147
  88. package/docs/build/OpenAI.js +0 -122
  89. package/docs/build/Playwright.js +0 -4134
  90. package/docs/build/Polly.js +0 -42
  91. package/docs/build/Protractor.js +0 -2701
  92. package/docs/build/Puppeteer.js +0 -3743
  93. package/docs/build/REST.js +0 -344
  94. package/docs/build/SeleniumWebdriver.js +0 -76
  95. package/docs/build/TestCafe.js +0 -2059
  96. package/docs/build/WebDriver.js +0 -4042
  97. package/docs/changelog.md +0 -2501
  98. package/docs/commands.md +0 -254
  99. package/docs/community-helpers.md +0 -58
  100. package/docs/configuration.md +0 -157
  101. package/docs/continuous-integration.md +0 -22
  102. package/docs/custom-helpers.md +0 -306
  103. package/docs/data.md +0 -375
  104. package/docs/detox.md +0 -235
  105. package/docs/docker.md +0 -137
  106. package/docs/email.md +0 -183
  107. package/docs/examples.md +0 -149
  108. package/docs/helpers/ApiDataFactory.md +0 -266
  109. package/docs/helpers/Appium.md +0 -1317
  110. package/docs/helpers/Detox.md +0 -586
  111. package/docs/helpers/FileSystem.md +0 -152
  112. package/docs/helpers/GraphQL.md +0 -130
  113. package/docs/helpers/GraphQLDataFactory.md +0 -226
  114. package/docs/helpers/JSONResponse.md +0 -254
  115. package/docs/helpers/Mochawesome.md +0 -8
  116. package/docs/helpers/MockRequest.md +0 -377
  117. package/docs/helpers/Nightmare.md +0 -1258
  118. package/docs/helpers/OpenAI.md +0 -70
  119. package/docs/helpers/Playwright.md +0 -2250
  120. package/docs/helpers/Polly.md +0 -44
  121. package/docs/helpers/Puppeteer-firefox.md +0 -86
  122. package/docs/helpers/Puppeteer.md +0 -2147
  123. package/docs/helpers/REST.md +0 -218
  124. package/docs/helpers/TestCafe.md +0 -1224
  125. package/docs/helpers/WebDriver.md +0 -2325
  126. package/docs/hooks.md +0 -340
  127. package/docs/index.md +0 -111
  128. package/docs/installation.md +0 -75
  129. package/docs/internal-api.md +0 -265
  130. package/docs/locators.md +0 -331
  131. package/docs/mobile-react-native-locators.md +0 -67
  132. package/docs/mobile.md +0 -344
  133. package/docs/nightmare.md +0 -223
  134. package/docs/pageobjects.md +0 -291
  135. package/docs/parallel.md +0 -288
  136. package/docs/playwright.md +0 -609
  137. package/docs/plugins.md +0 -1225
  138. package/docs/puppeteer.md +0 -316
  139. package/docs/quickstart.md +0 -163
  140. package/docs/react.md +0 -69
  141. package/docs/reports.md +0 -392
  142. package/docs/secrets.md +0 -36
  143. package/docs/shadow.md +0 -68
  144. package/docs/shared/keys.mustache +0 -31
  145. package/docs/shared/react.mustache +0 -1
  146. package/docs/testcafe.md +0 -174
  147. package/docs/translation.md +0 -247
  148. package/docs/tutorial.md +0 -271
  149. package/docs/typescript.md +0 -180
  150. package/docs/ui.md +0 -59
  151. package/docs/videos.md +0 -28
  152. package/docs/visual.md +0 -202
  153. package/docs/vue.md +0 -121
  154. package/docs/webapi/amOnPage.mustache +0 -11
  155. package/docs/webapi/appendField.mustache +0 -11
  156. package/docs/webapi/attachFile.mustache +0 -12
  157. package/docs/webapi/checkOption.mustache +0 -13
  158. package/docs/webapi/clearCookie.mustache +0 -10
  159. package/docs/webapi/clearField.mustache +0 -9
  160. package/docs/webapi/click.mustache +0 -25
  161. package/docs/webapi/clickLink.mustache +0 -8
  162. package/docs/webapi/closeCurrentTab.mustache +0 -7
  163. package/docs/webapi/closeOtherTabs.mustache +0 -8
  164. package/docs/webapi/dontSee.mustache +0 -11
  165. package/docs/webapi/dontSeeCheckboxIsChecked.mustache +0 -10
  166. package/docs/webapi/dontSeeCookie.mustache +0 -8
  167. package/docs/webapi/dontSeeCurrentUrlEquals.mustache +0 -10
  168. package/docs/webapi/dontSeeElement.mustache +0 -8
  169. package/docs/webapi/dontSeeElementInDOM.mustache +0 -8
  170. package/docs/webapi/dontSeeInCurrentUrl.mustache +0 -4
  171. package/docs/webapi/dontSeeInField.mustache +0 -11
  172. package/docs/webapi/dontSeeInSource.mustache +0 -8
  173. package/docs/webapi/dontSeeInTitle.mustache +0 -8
  174. package/docs/webapi/doubleClick.mustache +0 -13
  175. package/docs/webapi/downloadFile.mustache +0 -12
  176. package/docs/webapi/dragAndDrop.mustache +0 -9
  177. package/docs/webapi/dragSlider.mustache +0 -11
  178. package/docs/webapi/executeAsyncScript.mustache +0 -24
  179. package/docs/webapi/executeScript.mustache +0 -26
  180. package/docs/webapi/fillField.mustache +0 -16
  181. package/docs/webapi/forceClick.mustache +0 -28
  182. package/docs/webapi/forceRightClick.mustache +0 -18
  183. package/docs/webapi/grabAllWindowHandles.mustache +0 -7
  184. package/docs/webapi/grabAttributeFrom.mustache +0 -10
  185. package/docs/webapi/grabAttributeFromAll.mustache +0 -9
  186. package/docs/webapi/grabBrowserLogs.mustache +0 -9
  187. package/docs/webapi/grabCookie.mustache +0 -11
  188. package/docs/webapi/grabCssPropertyFrom.mustache +0 -11
  189. package/docs/webapi/grabCssPropertyFromAll.mustache +0 -10
  190. package/docs/webapi/grabCurrentUrl.mustache +0 -9
  191. package/docs/webapi/grabCurrentWindowHandle.mustache +0 -6
  192. package/docs/webapi/grabDataFromPerformanceTiming.mustache +0 -20
  193. package/docs/webapi/grabElementBoundingRect.mustache +0 -20
  194. package/docs/webapi/grabGeoLocation.mustache +0 -8
  195. package/docs/webapi/grabHTMLFrom.mustache +0 -10
  196. package/docs/webapi/grabHTMLFromAll.mustache +0 -9
  197. package/docs/webapi/grabNumberOfOpenTabs.mustache +0 -8
  198. package/docs/webapi/grabNumberOfVisibleElements.mustache +0 -9
  199. package/docs/webapi/grabPageScrollPosition.mustache +0 -8
  200. package/docs/webapi/grabPopupText.mustache +0 -5
  201. package/docs/webapi/grabSource.mustache +0 -8
  202. package/docs/webapi/grabTextFrom.mustache +0 -10
  203. package/docs/webapi/grabTextFromAll.mustache +0 -9
  204. package/docs/webapi/grabTitle.mustache +0 -8
  205. package/docs/webapi/grabValueFrom.mustache +0 -9
  206. package/docs/webapi/grabValueFromAll.mustache +0 -8
  207. package/docs/webapi/moveCursorTo.mustache +0 -12
  208. package/docs/webapi/openNewTab.mustache +0 -7
  209. package/docs/webapi/pressKey.mustache +0 -12
  210. package/docs/webapi/pressKeyDown.mustache +0 -12
  211. package/docs/webapi/pressKeyUp.mustache +0 -12
  212. package/docs/webapi/pressKeyWithKeyNormalization.mustache +0 -60
  213. package/docs/webapi/refreshPage.mustache +0 -6
  214. package/docs/webapi/resizeWindow.mustache +0 -6
  215. package/docs/webapi/rightClick.mustache +0 -14
  216. package/docs/webapi/saveElementScreenshot.mustache +0 -10
  217. package/docs/webapi/saveScreenshot.mustache +0 -12
  218. package/docs/webapi/say.mustache +0 -10
  219. package/docs/webapi/scrollIntoView.mustache +0 -11
  220. package/docs/webapi/scrollPageToBottom.mustache +0 -6
  221. package/docs/webapi/scrollPageToTop.mustache +0 -6
  222. package/docs/webapi/scrollTo.mustache +0 -12
  223. package/docs/webapi/see.mustache +0 -11
  224. package/docs/webapi/seeAttributesOnElements.mustache +0 -9
  225. package/docs/webapi/seeCheckboxIsChecked.mustache +0 -10
  226. package/docs/webapi/seeCookie.mustache +0 -8
  227. package/docs/webapi/seeCssPropertiesOnElements.mustache +0 -9
  228. package/docs/webapi/seeCurrentUrlEquals.mustache +0 -11
  229. package/docs/webapi/seeElement.mustache +0 -8
  230. package/docs/webapi/seeElementInDOM.mustache +0 -8
  231. package/docs/webapi/seeInCurrentUrl.mustache +0 -8
  232. package/docs/webapi/seeInField.mustache +0 -12
  233. package/docs/webapi/seeInPopup.mustache +0 -8
  234. package/docs/webapi/seeInSource.mustache +0 -7
  235. package/docs/webapi/seeInTitle.mustache +0 -8
  236. package/docs/webapi/seeNumberOfElements.mustache +0 -11
  237. package/docs/webapi/seeNumberOfVisibleElements.mustache +0 -10
  238. package/docs/webapi/seeTextEquals.mustache +0 -9
  239. package/docs/webapi/seeTitleEquals.mustache +0 -8
  240. package/docs/webapi/selectOption.mustache +0 -21
  241. package/docs/webapi/setCookie.mustache +0 -16
  242. package/docs/webapi/setGeoLocation.mustache +0 -12
  243. package/docs/webapi/switchTo.mustache +0 -9
  244. package/docs/webapi/switchToNextTab.mustache +0 -10
  245. package/docs/webapi/switchToPreviousTab.mustache +0 -10
  246. package/docs/webapi/type.mustache +0 -21
  247. package/docs/webapi/uncheckOption.mustache +0 -13
  248. package/docs/webapi/wait.mustache +0 -8
  249. package/docs/webapi/waitForClickable.mustache +0 -11
  250. package/docs/webapi/waitForDetached.mustache +0 -10
  251. package/docs/webapi/waitForElement.mustache +0 -11
  252. package/docs/webapi/waitForEnabled.mustache +0 -6
  253. package/docs/webapi/waitForFunction.mustache +0 -17
  254. package/docs/webapi/waitForInvisible.mustache +0 -10
  255. package/docs/webapi/waitForText.mustache +0 -13
  256. package/docs/webapi/waitForValue.mustache +0 -10
  257. package/docs/webapi/waitForVisible.mustache +0 -10
  258. package/docs/webapi/waitInUrl.mustache +0 -9
  259. package/docs/webapi/waitNumberOfVisibleElements.mustache +0 -10
  260. package/docs/webapi/waitToHide.mustache +0 -10
  261. package/docs/webapi/waitUrlEquals.mustache +0 -10
  262. package/docs/webdriver.md +0 -657
  263. package/docs/wiki/Books-&-Posts.md +0 -27
  264. package/docs/wiki/Community-Helpers-&-Plugins.md +0 -49
  265. package/docs/wiki/Converting-Playwright-to-Istanbul-Coverage.md +0 -29
  266. package/docs/wiki/Examples.md +0 -139
  267. package/docs/wiki/Google-Summer-of-Code-(GSoC)-2020.md +0 -68
  268. package/docs/wiki/Home.md +0 -16
  269. package/docs/wiki/Release-Process.md +0 -24
  270. package/docs/wiki/Roadmap.md +0 -23
  271. package/docs/wiki/Tests.md +0 -1393
  272. package/docs/wiki/Upgrading-to-CodeceptJS-3.md +0 -153
  273. package/docs/wiki/Videos.md +0 -19
@@ -1,60 +0,0 @@
1
- Presses a key in the browser (on a focused element).
2
-
3
- _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
4
-
5
- ```js
6
- I.pressKey('Backspace');
7
- ```
8
-
9
- To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys (`'Alt'`, `'Control'`, `'Meta'`, `'Shift'`) will be released afterwards.
10
-
11
- ```js
12
- I.pressKey(['Control', 'Z']);
13
- ```
14
-
15
- For specifying operation modifier key based on operating system it is suggested to use `'CommandOrControl'`.
16
- This will press `'Command'` (also known as `'Meta'`) on macOS machines and `'Control'` on non-macOS machines.
17
-
18
- ```js
19
- I.pressKey(['CommandOrControl', 'Z']);
20
- ```
21
-
22
- Some of the supported key names are:
23
- - `'AltLeft'` or `'Alt'`
24
- - `'AltRight'`
25
- - `'ArrowDown'`
26
- - `'ArrowLeft'`
27
- - `'ArrowRight'`
28
- - `'ArrowUp'`
29
- - `'Backspace'`
30
- - `'Clear'`
31
- - `'ControlLeft'` or `'Control'`
32
- - `'ControlRight'`
33
- - `'Command'`
34
- - `'CommandOrControl'`
35
- - `'Delete'`
36
- - `'End'`
37
- - `'Enter'`
38
- - `'Escape'`
39
- - `'F1'` to `'F12'`
40
- - `'Home'`
41
- - `'Insert'`
42
- - `'MetaLeft'` or `'Meta'`
43
- - `'MetaRight'`
44
- - `'Numpad0'` to `'Numpad9'`
45
- - `'NumpadAdd'`
46
- - `'NumpadDecimal'`
47
- - `'NumpadDivide'`
48
- - `'NumpadMultiply'`
49
- - `'NumpadSubtract'`
50
- - `'PageDown'`
51
- - `'PageUp'`
52
- - `'Pause'`
53
- - `'Return'`
54
- - `'ShiftLeft'` or `'Shift'`
55
- - `'ShiftRight'`
56
- - `'Space'`
57
- - `'Tab'`
58
-
59
- @param {string|string[]} key key or array of keys to press.
60
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,6 +0,0 @@
1
- Reload the current page.
2
-
3
- ```js
4
- I.refreshPage();
5
- ```
6
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,6 +0,0 @@
1
- Resize the current window to provided width and height.
2
- First parameter can be set to `maximize`.
3
-
4
- @param {number} width width in pixels or `maximize`.
5
- @param {number} height height in pixels.
6
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,14 +0,0 @@
1
- Performs right click on a clickable element matched by semantic locator, CSS or XPath.
2
-
3
- ```js
4
- // right click element with id el
5
- I.rightClick('#el');
6
- // right click link or button with text "Click me"
7
- I.rightClick('Click me');
8
- // right click button with text "Click me" inside .context
9
- I.rightClick('Click me', '.context');
10
- ```
11
-
12
- @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
13
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
14
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
2
- Filename is relative to output folder.
3
-
4
- ```js
5
- I.saveElementScreenshot(`#submit`,'debug.png');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {string} fileName file name to save.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,12 +0,0 @@
1
- Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
2
- Filename is relative to output folder.
3
- Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
4
-
5
- ```js
6
- I.saveScreenshot('debug.png');
7
- I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
8
- ```
9
-
10
- @param {string} fileName file name to save.
11
- @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
12
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Print a text in console log
2
-
3
- ```js
4
- I.say('This is red', 'red'); //red is used
5
- I.say('This is blue', 'blue'); //blue is used
6
- I.say('This is by default'); //cyan is used
7
- ```
8
- @param {string} text expected on console log.
9
- @param {string} [color='cyan'] color you want to use.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Scroll element into viewport.
2
-
3
- ```js
4
- I.scrollIntoView('#submit');
5
- I.scrollIntoView('#submit', true);
6
- I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
7
- ```
8
-
9
- @param {LocatorOrString} locator located by CSS|XPath|strict locator.
10
- @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,6 +0,0 @@
1
- Scroll page to the bottom.
2
-
3
- ```js
4
- I.scrollPageToBottom();
5
- ```
6
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,6 +0,0 @@
1
- Scroll page to the top.
2
-
3
- ```js
4
- I.scrollPageToTop();
5
- ```
6
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,12 +0,0 @@
1
- Scrolls to element matched by locator.
2
- Extra shift can be set with offsetX and offsetY options.
3
-
4
- ```js
5
- I.scrollTo('footer');
6
- I.scrollTo('#submit', 5, 5);
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
10
- @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
11
- @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
12
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Checks that a page contains a visible text.
2
- Use context parameter to narrow down the search.
3
-
4
- ```js
5
- I.see('Welcome'); // text welcome on a page
6
- I.see('Welcome', '.content'); // text inside .content div
7
- I.see('Register', {css: 'form.register'}); // use strict locator
8
- ```
9
- @param {string} text expected on page.
10
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,9 +0,0 @@
1
- Checks that all elements with given locator have given attributes.
2
-
3
- ```js
4
- I.seeAttributesOnElements('//form', { method: "post"});
5
- ```
6
-
7
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
- @param {object} attributes attributes and their values to check.
9
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Verifies that the specified checkbox is checked.
2
-
3
- ```js
4
- I.seeCheckboxIsChecked('Agree');
5
- I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
6
- I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that cookie with given name exists.
2
-
3
- ```js
4
- I.seeCookie('Auth');
5
- ```
6
-
7
- @param {string} name cookie name.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,9 +0,0 @@
1
- Checks that all elements with given locator have given CSS properties.
2
-
3
- ```js
4
- I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
5
- ```
6
-
7
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
- @param {object} cssProperties object with CSS properties and their values to check.
9
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Checks that current url is equal to provided one.
2
- If a relative url provided, a configured url will be prepended to it.
3
- So both examples will work:
4
-
5
- ```js
6
- I.seeCurrentUrlEquals('/register');
7
- I.seeCurrentUrlEquals('http://my.site.com/register');
8
- ```
9
-
10
- @param {string} url value to check.
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that a given Element is visible
2
- Element is located by CSS or XPath.
3
-
4
- ```js
5
- I.seeElement('#modal');
6
- ```
7
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that a given Element is present in the DOM
2
- Element is located by CSS or XPath.
3
-
4
- ```js
5
- I.seeElementInDOM('#modal');
6
- ```
7
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that current url contains a provided fragment.
2
-
3
- ```js
4
- I.seeInCurrentUrl('/register'); // we are on registration page
5
- ```
6
-
7
- @param {string} url a fragment to check
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,12 +0,0 @@
1
- Checks that the given input field or textarea equals to given value.
2
- For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
3
-
4
- ```js
5
- I.seeInField('Username', 'davert');
6
- I.seeInField({css: 'form textarea'},'Type your comment here');
7
- I.seeInField('form input[type=hidden]','hidden_value');
8
- I.seeInField('#searchform input','Search');
9
- ```
10
- @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
11
- @param {string} value value to check.
12
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
2
- given string.
3
-
4
- ```js
5
- I.seeInPopup('Popup text');
6
- ```
7
- @param {string} text value to check.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,7 +0,0 @@
1
- Checks that the current page contains the given string in its raw source code.
2
-
3
- ```js
4
- I.seeInSource('<h1>Green eggs &amp; ham</h1>');
5
- ```
6
- @param {string} text value to check.
7
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that title contains text.
2
-
3
- ```js
4
- I.seeInTitle('Home Page');
5
- ```
6
-
7
- @param {string} text text value to check.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Asserts that an element appears a given number of times in the DOM.
2
- Element is located by label or name or CSS or XPath.
3
-
4
-
5
- ```js
6
- I.seeNumberOfElements('#submitBtn', 1);
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
- @param {number} num number of elements.
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Asserts that an element is visible a given number of times.
2
- Element is located by CSS or XPath.
3
-
4
- ```js
5
- I.seeNumberOfVisibleElements('.buttons', 3);
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {number} num number of elements.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,9 +0,0 @@
1
- Checks that text is equal to provided one.
2
-
3
- ```js
4
- I.seeTextEquals('text', 'h1');
5
- ```
6
-
7
- @param {string} text element value to check.
8
- @param {CodeceptJS.LocatorOrString?} [context=null] element located by CSS|XPath|strict locator.
9
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Checks that title is equal to provided one.
2
-
3
- ```js
4
- I.seeTitleEquals('Test title.');
5
- ```
6
-
7
- @param {string} text value to check.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,21 +0,0 @@
1
- Selects an option in a drop-down select.
2
- Field is searched by label | name | CSS | XPath.
3
- Option is selected by visible text or by value.
4
-
5
- ```js
6
- I.selectOption('Choose Plan', 'Monthly'); // select by label
7
- I.selectOption('subscription', 'Monthly'); // match option by text
8
- I.selectOption('subscription', '0'); // or by value
9
- I.selectOption('//form/select[@name=account]','Premium');
10
- I.selectOption('form select[name=account]', 'Premium');
11
- I.selectOption({css: 'form select[name=account]'}, 'Premium');
12
- ```
13
-
14
- Provide an array for the second argument to select multiple options.
15
-
16
- ```js
17
- I.selectOption('Which OS do you use?', ['Android', 'iOS']);
18
- ```
19
- @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
20
- @param {string|Array<*>} option visible text or value of option.
21
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,16 +0,0 @@
1
- Sets cookie(s).
2
-
3
- Can be a single cookie object or an array of cookies:
4
-
5
- ```js
6
- I.setCookie({name: 'auth', value: true});
7
-
8
- // as array
9
- I.setCookie([
10
- {name: 'auth', value: true},
11
- {name: 'agree', value: true}
12
- ]);
13
- ```
14
-
15
- @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
16
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,12 +0,0 @@
1
- Set the current geo location
2
-
3
-
4
- ```js
5
- I.setGeoLocation(121.21, 11.56);
6
- I.setGeoLocation(121.21, 11.56, 10);
7
- ```
8
-
9
- @param {number} latitude to set.
10
- @param {number} longitude to set
11
- @param {number=} altitude (optional, null by default) to set
12
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,9 +0,0 @@
1
- Switches frame or in case of null locator reverts to parent.
2
-
3
- ```js
4
- I.switchTo('iframe'); // switch to first iframe
5
- I.switchTo(); // switch back to main page
6
- ```
7
-
8
- @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
9
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
2
-
3
- ```js
4
- I.switchToNextTab();
5
- I.switchToNextTab(2);
6
- ```
7
-
8
- @param {number} [num] (optional) number of tabs to switch forward, default: 1.
9
- @param {number | null} [sec] (optional) time in seconds to wait.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
2
-
3
- ```js
4
- I.switchToPreviousTab();
5
- I.switchToPreviousTab(2);
6
- ```
7
-
8
- @param {number} [num] (optional) number of tabs to switch backward, default: 1.
9
- @param {number?} [sec] (optional) time in seconds to wait.
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,21 +0,0 @@
1
- Types out the given text into an active field.
2
- To slow down typing use a second parameter, to set interval between key presses.
3
- _Note:_ Should be used when [`fillField`](#fillfield) is not an option.
4
-
5
- ```js
6
- // passing in a string
7
- I.type('Type this out.');
8
-
9
- // typing values with a 100ms interval
10
- I.type('4141555311111111', 100);
11
-
12
- // passing in an array
13
- I.type(['T', 'E', 'X', 'T']);
14
-
15
- // passing a secret
16
- I.type(secret('123456'));
17
- ```
18
-
19
- @param {string|string[]} key or array of keys to type.
20
- @param {?number} [delay=null] (optional) delay in ms between key presses
21
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,13 +0,0 @@
1
- Unselects a checkbox or radio button.
2
- Element is located by label or name or CSS or XPath.
3
-
4
- The second parameter is a context (CSS or XPath locator) to narrow the search.
5
-
6
- ```js
7
- I.uncheckOption('#agree');
8
- I.uncheckOption('I Agree to Terms and Conditions');
9
- I.uncheckOption('agree', '//form');
10
- ```
11
- @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
12
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
13
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,8 +0,0 @@
1
- Pauses execution for a number of seconds.
2
-
3
- ```js
4
- I.wait(2); // wait 2 secs
5
- ```
6
-
7
- @param {number} sec number of second to wait.
8
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Waits for element to be clickable (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitForClickable('.btn.continue');
6
- I.waitForClickable('.btn.continue', 5); // wait for 5 secs
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
- @param {number} [sec] (optional, `1` by default) time in seconds to wait
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitForDetached('#popup');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,11 +0,0 @@
1
- Waits for element to be present on page (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitForElement('.btn.continue');
6
- I.waitForElement('.btn.continue', 5); // wait for 5 secs
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
- @param {number} [sec] (optional, `1` by default) time in seconds to wait
11
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,6 +0,0 @@
1
- Waits for element to become enabled (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
5
- @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
6
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,17 +0,0 @@
1
- Waits for a function to return true (waits for 1 sec by default).
2
- Running in browser context.
3
-
4
- ```js
5
- I.waitForFunction(fn[, [args[, timeout]])
6
- ```
7
-
8
- ```js
9
- I.waitForFunction(() => window.requests == 0);
10
- I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
11
- I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
12
- ```
13
-
14
- @param {string|function} fn to be executed in browser context.
15
- @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
16
- @param {number} [sec] (optional, `1` by default) time in seconds to wait
17
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitForInvisible('#popup');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,13 +0,0 @@
1
- Waits for a text to appear (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
- Narrow down search results by providing context.
4
-
5
- ```js
6
- I.waitForText('Thank you, form has been submitted');
7
- I.waitForText('Thank you, form has been submitted', 5, '#modal');
8
- ```
9
-
10
- @param {string }text to wait for.
11
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
12
- @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
13
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for the specified value to be in value attribute.
2
-
3
- ```js
4
- I.waitForValue('//input', "GoodValue");
5
- ```
6
-
7
- @param {LocatorOrString} field input field.
8
- @param {string }value expected value.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for an element to become visible on a page (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitForVisible('#popup');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,9 +0,0 @@
1
- Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
2
-
3
- ```js
4
- I.waitInUrl('/info', 2);
5
- ```
6
-
7
- @param {string} urlPart value to check.
8
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
9
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for a specified number of elements on the page.
2
-
3
- ```js
4
- I.waitNumberOfVisibleElements('a', 3);
5
- ```
6
-
7
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
8
- @param {number} num number of elements.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,10 +0,0 @@
1
- Waits for an element to hide (by default waits for 1sec).
2
- Element can be located by CSS or XPath.
3
-
4
- ```js
5
- I.waitToHide('#popup');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
10
- ⚠️ returns a _promise_ which is synchronized internally by recorder