codeceptjs 3.5.12-beta.2 → 3.5.12-beta.3

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 (213) hide show
  1. package/lib/locator.js +7 -12
  2. package/package.json +3 -5
  3. package/docs/advanced.md +0 -351
  4. package/docs/ai.md +0 -248
  5. package/docs/api.md +0 -323
  6. package/docs/basics.md +0 -979
  7. package/docs/bdd.md +0 -539
  8. package/docs/best.md +0 -237
  9. package/docs/books.md +0 -37
  10. package/docs/bootstrap.md +0 -135
  11. package/docs/build/ApiDataFactory.js +0 -410
  12. package/docs/build/Appium.js +0 -2027
  13. package/docs/build/Expect.js +0 -422
  14. package/docs/build/FileSystem.js +0 -228
  15. package/docs/build/GraphQL.js +0 -229
  16. package/docs/build/GraphQLDataFactory.js +0 -309
  17. package/docs/build/JSONResponse.js +0 -338
  18. package/docs/build/Mochawesome.js +0 -71
  19. package/docs/build/Nightmare.js +0 -2152
  20. package/docs/build/OpenAI.js +0 -126
  21. package/docs/build/Playwright.js +0 -5110
  22. package/docs/build/Protractor.js +0 -2706
  23. package/docs/build/Puppeteer.js +0 -3905
  24. package/docs/build/REST.js +0 -344
  25. package/docs/build/TestCafe.js +0 -2125
  26. package/docs/build/WebDriver.js +0 -4240
  27. package/docs/changelog.md +0 -2572
  28. package/docs/commands.md +0 -266
  29. package/docs/community-helpers.md +0 -58
  30. package/docs/configuration.md +0 -157
  31. package/docs/continuous-integration.md +0 -22
  32. package/docs/custom-helpers.md +0 -306
  33. package/docs/data.md +0 -379
  34. package/docs/detox.md +0 -235
  35. package/docs/docker.md +0 -136
  36. package/docs/email.md +0 -183
  37. package/docs/examples.md +0 -149
  38. package/docs/helpers/ApiDataFactory.md +0 -266
  39. package/docs/helpers/Appium.md +0 -1374
  40. package/docs/helpers/Detox.md +0 -586
  41. package/docs/helpers/Expect.md +0 -275
  42. package/docs/helpers/FileSystem.md +0 -152
  43. package/docs/helpers/GraphQL.md +0 -151
  44. package/docs/helpers/GraphQLDataFactory.md +0 -226
  45. package/docs/helpers/JSONResponse.md +0 -254
  46. package/docs/helpers/Mochawesome.md +0 -8
  47. package/docs/helpers/MockRequest.md +0 -377
  48. package/docs/helpers/Nightmare.md +0 -1305
  49. package/docs/helpers/OpenAI.md +0 -70
  50. package/docs/helpers/Playwright.md +0 -2759
  51. package/docs/helpers/Polly.md +0 -44
  52. package/docs/helpers/Protractor.md +0 -1769
  53. package/docs/helpers/Puppeteer-firefox.md +0 -86
  54. package/docs/helpers/Puppeteer.md +0 -2317
  55. package/docs/helpers/REST.md +0 -218
  56. package/docs/helpers/TestCafe.md +0 -1321
  57. package/docs/helpers/WebDriver.md +0 -2547
  58. package/docs/hooks.md +0 -340
  59. package/docs/index.md +0 -111
  60. package/docs/installation.md +0 -75
  61. package/docs/internal-api.md +0 -266
  62. package/docs/locators.md +0 -339
  63. package/docs/mobile-react-native-locators.md +0 -67
  64. package/docs/mobile.md +0 -338
  65. package/docs/pageobjects.md +0 -291
  66. package/docs/parallel.md +0 -400
  67. package/docs/playwright.md +0 -632
  68. package/docs/plugins.md +0 -1259
  69. package/docs/puppeteer.md +0 -316
  70. package/docs/quickstart.md +0 -162
  71. package/docs/react.md +0 -70
  72. package/docs/reports.md +0 -392
  73. package/docs/secrets.md +0 -36
  74. package/docs/shadow.md +0 -68
  75. package/docs/shared/keys.mustache +0 -31
  76. package/docs/shared/react.mustache +0 -1
  77. package/docs/testcafe.md +0 -174
  78. package/docs/translation.md +0 -247
  79. package/docs/tutorial.md +0 -271
  80. package/docs/typescript.md +0 -180
  81. package/docs/ui.md +0 -59
  82. package/docs/videos.md +0 -28
  83. package/docs/visual.md +0 -202
  84. package/docs/vue.md +0 -143
  85. package/docs/webapi/amOnPage.mustache +0 -11
  86. package/docs/webapi/appendField.mustache +0 -11
  87. package/docs/webapi/attachFile.mustache +0 -12
  88. package/docs/webapi/blur.mustache +0 -18
  89. package/docs/webapi/checkOption.mustache +0 -13
  90. package/docs/webapi/clearCookie.mustache +0 -9
  91. package/docs/webapi/clearField.mustache +0 -9
  92. package/docs/webapi/click.mustache +0 -25
  93. package/docs/webapi/clickLink.mustache +0 -8
  94. package/docs/webapi/closeCurrentTab.mustache +0 -7
  95. package/docs/webapi/closeOtherTabs.mustache +0 -8
  96. package/docs/webapi/dontSee.mustache +0 -11
  97. package/docs/webapi/dontSeeCheckboxIsChecked.mustache +0 -10
  98. package/docs/webapi/dontSeeCookie.mustache +0 -8
  99. package/docs/webapi/dontSeeCurrentUrlEquals.mustache +0 -10
  100. package/docs/webapi/dontSeeElement.mustache +0 -8
  101. package/docs/webapi/dontSeeElementInDOM.mustache +0 -8
  102. package/docs/webapi/dontSeeInCurrentUrl.mustache +0 -4
  103. package/docs/webapi/dontSeeInField.mustache +0 -11
  104. package/docs/webapi/dontSeeInSource.mustache +0 -8
  105. package/docs/webapi/dontSeeInTitle.mustache +0 -8
  106. package/docs/webapi/doubleClick.mustache +0 -13
  107. package/docs/webapi/downloadFile.mustache +0 -12
  108. package/docs/webapi/dragAndDrop.mustache +0 -9
  109. package/docs/webapi/dragSlider.mustache +0 -11
  110. package/docs/webapi/executeAsyncScript.mustache +0 -24
  111. package/docs/webapi/executeScript.mustache +0 -26
  112. package/docs/webapi/fillField.mustache +0 -16
  113. package/docs/webapi/focus.mustache +0 -13
  114. package/docs/webapi/forceClick.mustache +0 -28
  115. package/docs/webapi/forceRightClick.mustache +0 -18
  116. package/docs/webapi/grabAllWindowHandles.mustache +0 -7
  117. package/docs/webapi/grabAttributeFrom.mustache +0 -10
  118. package/docs/webapi/grabAttributeFromAll.mustache +0 -9
  119. package/docs/webapi/grabBrowserLogs.mustache +0 -9
  120. package/docs/webapi/grabCookie.mustache +0 -11
  121. package/docs/webapi/grabCssPropertyFrom.mustache +0 -11
  122. package/docs/webapi/grabCssPropertyFromAll.mustache +0 -10
  123. package/docs/webapi/grabCurrentUrl.mustache +0 -9
  124. package/docs/webapi/grabCurrentWindowHandle.mustache +0 -6
  125. package/docs/webapi/grabDataFromPerformanceTiming.mustache +0 -20
  126. package/docs/webapi/grabElementBoundingRect.mustache +0 -20
  127. package/docs/webapi/grabGeoLocation.mustache +0 -8
  128. package/docs/webapi/grabHTMLFrom.mustache +0 -10
  129. package/docs/webapi/grabHTMLFromAll.mustache +0 -9
  130. package/docs/webapi/grabNumberOfOpenTabs.mustache +0 -8
  131. package/docs/webapi/grabNumberOfVisibleElements.mustache +0 -9
  132. package/docs/webapi/grabPageScrollPosition.mustache +0 -8
  133. package/docs/webapi/grabPopupText.mustache +0 -5
  134. package/docs/webapi/grabSource.mustache +0 -8
  135. package/docs/webapi/grabTextFrom.mustache +0 -10
  136. package/docs/webapi/grabTextFromAll.mustache +0 -9
  137. package/docs/webapi/grabTitle.mustache +0 -8
  138. package/docs/webapi/grabValueFrom.mustache +0 -9
  139. package/docs/webapi/grabValueFromAll.mustache +0 -8
  140. package/docs/webapi/grabWebElement.mustache +0 -9
  141. package/docs/webapi/grabWebElements.mustache +0 -9
  142. package/docs/webapi/moveCursorTo.mustache +0 -12
  143. package/docs/webapi/openNewTab.mustache +0 -7
  144. package/docs/webapi/pressKey.mustache +0 -12
  145. package/docs/webapi/pressKeyDown.mustache +0 -12
  146. package/docs/webapi/pressKeyUp.mustache +0 -12
  147. package/docs/webapi/pressKeyWithKeyNormalization.mustache +0 -60
  148. package/docs/webapi/refreshPage.mustache +0 -6
  149. package/docs/webapi/resizeWindow.mustache +0 -6
  150. package/docs/webapi/rightClick.mustache +0 -14
  151. package/docs/webapi/saveElementScreenshot.mustache +0 -10
  152. package/docs/webapi/saveScreenshot.mustache +0 -12
  153. package/docs/webapi/say.mustache +0 -10
  154. package/docs/webapi/scrollIntoView.mustache +0 -11
  155. package/docs/webapi/scrollPageToBottom.mustache +0 -6
  156. package/docs/webapi/scrollPageToTop.mustache +0 -6
  157. package/docs/webapi/scrollTo.mustache +0 -12
  158. package/docs/webapi/see.mustache +0 -11
  159. package/docs/webapi/seeAttributesOnElements.mustache +0 -9
  160. package/docs/webapi/seeCheckboxIsChecked.mustache +0 -10
  161. package/docs/webapi/seeCookie.mustache +0 -8
  162. package/docs/webapi/seeCssPropertiesOnElements.mustache +0 -9
  163. package/docs/webapi/seeCurrentUrlEquals.mustache +0 -11
  164. package/docs/webapi/seeElement.mustache +0 -8
  165. package/docs/webapi/seeElementInDOM.mustache +0 -8
  166. package/docs/webapi/seeInCurrentUrl.mustache +0 -8
  167. package/docs/webapi/seeInField.mustache +0 -12
  168. package/docs/webapi/seeInPopup.mustache +0 -8
  169. package/docs/webapi/seeInSource.mustache +0 -7
  170. package/docs/webapi/seeInTitle.mustache +0 -8
  171. package/docs/webapi/seeNumberOfElements.mustache +0 -11
  172. package/docs/webapi/seeNumberOfVisibleElements.mustache +0 -10
  173. package/docs/webapi/seeTextEquals.mustache +0 -9
  174. package/docs/webapi/seeTitleEquals.mustache +0 -8
  175. package/docs/webapi/selectOption.mustache +0 -21
  176. package/docs/webapi/setCookie.mustache +0 -16
  177. package/docs/webapi/setGeoLocation.mustache +0 -12
  178. package/docs/webapi/switchTo.mustache +0 -9
  179. package/docs/webapi/switchToNextTab.mustache +0 -10
  180. package/docs/webapi/switchToPreviousTab.mustache +0 -10
  181. package/docs/webapi/type.mustache +0 -21
  182. package/docs/webapi/uncheckOption.mustache +0 -13
  183. package/docs/webapi/wait.mustache +0 -8
  184. package/docs/webapi/waitForClickable.mustache +0 -11
  185. package/docs/webapi/waitForDetached.mustache +0 -10
  186. package/docs/webapi/waitForElement.mustache +0 -11
  187. package/docs/webapi/waitForEnabled.mustache +0 -6
  188. package/docs/webapi/waitForFunction.mustache +0 -17
  189. package/docs/webapi/waitForInvisible.mustache +0 -10
  190. package/docs/webapi/waitForNumberOfTabs.mustache +0 -9
  191. package/docs/webapi/waitForText.mustache +0 -13
  192. package/docs/webapi/waitForValue.mustache +0 -10
  193. package/docs/webapi/waitForVisible.mustache +0 -10
  194. package/docs/webapi/waitInUrl.mustache +0 -9
  195. package/docs/webapi/waitNumberOfVisibleElements.mustache +0 -10
  196. package/docs/webapi/waitToHide.mustache +0 -10
  197. package/docs/webapi/waitUrlEquals.mustache +0 -10
  198. package/docs/webdriver.md +0 -701
  199. package/docs/wiki/Books-&-Posts.md +0 -27
  200. package/docs/wiki/Community-Helpers-&-Plugins.md +0 -53
  201. package/docs/wiki/Converting-Playwright-to-Istanbul-Coverage.md +0 -61
  202. package/docs/wiki/Examples.md +0 -145
  203. package/docs/wiki/Google-Summer-of-Code-(GSoC)-2020.md +0 -68
  204. package/docs/wiki/Home.md +0 -16
  205. package/docs/wiki/Migration-to-Appium-v2---CodeceptJS.md +0 -83
  206. package/docs/wiki/Release-Process.md +0 -24
  207. package/docs/wiki/Roadmap.md +0 -23
  208. package/docs/wiki/Tests.md +0 -1393
  209. package/docs/wiki/Upgrading-to-CodeceptJS-3.md +0 -153
  210. package/docs/wiki/Videos.md +0 -19
  211. package/lib/css2xpath/js/css_to_xpath.js +0 -20
  212. package/lib/css2xpath/js/expression.js +0 -23
  213. package/lib/css2xpath/js/renderer.js +0 -239
@@ -1,9 +0,0 @@
1
- Clears a `<textarea>` or text `<input>` element's value.
2
-
3
- ```js
4
- I.clearField('Email');
5
- I.clearField('user[email]');
6
- I.clearField('#email');
7
- ```
8
- @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
9
- @returns {void} automatically synchronized promise through #recorder.
@@ -1,25 +0,0 @@
1
- Perform a click on a link or a button, given by a locator.
2
- If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
3
- For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
4
- For images, the "alt" attribute and inner text of any parent links are searched.
5
-
6
- The second parameter is a context (CSS or XPath locator) to narrow the search.
7
-
8
- ```js
9
- // simple link
10
- I.click('Logout');
11
- // button of form
12
- I.click('Submit');
13
- // CSS button
14
- I.click('#form input[type=submit]');
15
- // XPath
16
- I.click('//form/*[@type=submit]');
17
- // link in context
18
- I.click('Logout', '#nav');
19
- // using strict locator
20
- I.click({css: 'nav a.login'});
21
- ```
22
-
23
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
24
- @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
25
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Performs a click on a link and waits for navigation before moving on.
2
-
3
- ```js
4
- I.clickLink('Logout', '#nav');
5
- ```
6
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
7
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,7 +0,0 @@
1
- Close current tab.
2
-
3
- ```js
4
- I.closeCurrentTab();
5
- ```
6
-
7
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Close all tabs except for the current one.
2
-
3
-
4
- ```js
5
- I.closeOtherTabs();
6
- ```
7
-
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,11 +0,0 @@
1
- Opposite to `see`. Checks that a text is not present on a page.
2
- Use context parameter to narrow down the search.
3
-
4
- ```js
5
- I.dontSee('Login'); // assume we are already logged in.
6
- I.dontSee('Login', '.nav'); // no login inside .nav element
7
- ```
8
-
9
- @param {string} text which is not present.
10
- @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
11
- @returns {void} automatically synchronized promise through #recorder
@@ -1,10 +0,0 @@
1
- Verifies that the specified checkbox is not checked.
2
-
3
- ```js
4
- I.dontSeeCheckboxIsChecked('#agree'); // located by ID
5
- I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
6
- I.dontSeeCheckboxIsChecked('agree'); // located by name
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Checks that cookie with given name does not exist.
2
-
3
- ```js
4
- I.dontSeeCookie('auth'); // no auth cookie
5
- ```
6
-
7
- @param {string} name cookie name.
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,10 +0,0 @@
1
- Checks that current url is not equal to provided one.
2
- If a relative url provided, a configured url will be prepended to it.
3
-
4
- ```js
5
- I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
6
- I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
7
- ```
8
-
9
- @param {string} url value to check.
10
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Opposite to `seeElement`. Checks that element is not visible (or in DOM)
2
-
3
- ```js
4
- I.dontSeeElement('.modal'); // modal is not shown
5
- ```
6
-
7
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Opposite to `seeElementInDOM`. Checks that element is not on page.
2
-
3
- ```js
4
- I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
5
- ```
6
-
7
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,4 +0,0 @@
1
- Checks that current url does not contain a provided fragment.
2
-
3
- @param {string} url value to check.
4
- @returns {void} automatically synchronized promise through #recorder
@@ -1,11 +0,0 @@
1
- Checks that value of input field or textarea doesn't equal to given value
2
- Opposite to `seeInField`.
3
-
4
- ```js
5
- I.dontSeeInField('email', 'user@user.com'); // field by name
6
- I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
- @param {CodeceptJS.StringOrSecret} value value to check.
11
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Checks that the current page does not contains the given string in its raw source code.
2
-
3
- ```js
4
- I.dontSeeInSource('<!--'); // no comments in source
5
- ```
6
-
7
- @param {string} value to check.
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,8 +0,0 @@
1
- Checks that title does not contain text.
2
-
3
- ```js
4
- I.dontSeeInTitle('Error');
5
- ```
6
-
7
- @param {string} text value to check.
8
- @returns {void} automatically synchronized promise through #recorder
@@ -1,13 +0,0 @@
1
- Performs a double-click on an element matched by link|button|label|CSS or XPath.
2
- Context can be specified as second parameter to narrow search.
3
-
4
- ```js
5
- I.doubleClick('Edit');
6
- I.doubleClick('Edit', '.actions');
7
- I.doubleClick({css: 'button.accept'});
8
- I.doubleClick('.btn.edit');
9
- ```
10
-
11
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
12
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
13
- @returns {void} automatically synchronized promise through #recorder
@@ -1,12 +0,0 @@
1
- Performs a download file on an element matched by link|button|CSS or XPath.
2
- File is downloaded by default to output folder.
3
- If no custom file name is provided, the default name will be used
4
-
5
-
6
- ```js
7
- I.downloadFile('td[class="text-right file-link"] a', 'thisIsCustomName');
8
- ```
9
-
10
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by CSS|XPath locator.
11
- @param {string} file custom file name.
12
- @returns {void} automatically synchronized promise through #recorder
@@ -1,9 +0,0 @@
1
- Drag an item to a destination element.
2
-
3
- ```js
4
- I.dragAndDrop('#dragHandle', '#container');
5
- ```
6
-
7
- @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
8
- @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
9
- @returns {void} automatically synchronized promise through #recorder
@@ -1,11 +0,0 @@
1
- Drag the scrubber of a slider to a given position
2
- For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
3
-
4
- ```js
5
- I.dragSlider('#slider', 30);
6
- I.dragSlider('#slider', -70);
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
10
- @param {number} offsetX position to drag.
11
- @returns {void} automatically synchronized promise through #recorder
@@ -1,24 +0,0 @@
1
- Executes async script on page.
2
- Provided function should execute a passed callback (as first argument) to signal it is finished.
3
-
4
- Example: In Vue.js to make components completely rendered we are waiting for [nextTick](https://vuejs.org/v2/api/#Vue-nextTick).
5
-
6
- ```js
7
- I.executeAsyncScript(function(done) {
8
- Vue.nextTick(done); // waiting for next tick
9
- });
10
- ```
11
-
12
- By passing value to `done()` function you can return values.
13
- Additional arguments can be passed as well, while `done` function is always last parameter in arguments list.
14
-
15
- ```js
16
- let val = await I.executeAsyncScript(function(url, done) {
17
- // in browser context
18
- $.ajax(url, { success: (data) => done(data); }
19
- }, 'http://ajax.callback.url/');
20
- ```
21
-
22
- @param {string|function} fn function to be executed in browser context.
23
- @param {...any} args to be passed to function.
24
- @returns {Promise<any>} script return value
@@ -1,26 +0,0 @@
1
- Executes sync script on a page.
2
- Pass arguments to function as additional parameters.
3
- Will return execution result to a test.
4
- In this case you should use async function and await to receive results.
5
-
6
- Example with jQuery DatePicker:
7
-
8
- ```js
9
- // change date of jQuery DatePicker
10
- I.executeScript(function() {
11
- // now we are inside browser context
12
- $('date').datetimepicker('setDate', new Date());
13
- });
14
- ```
15
- Can return values. Don't forget to use `await` to get them.
16
-
17
- ```js
18
- let date = await I.executeScript(function(el) {
19
- // only basic types can be returned
20
- return $(el).datetimepicker('getDate').toString();
21
- }, '#date'); // passing jquery selector
22
- ```
23
-
24
- @param {string|function} fn function to be executed in browser context.
25
- @param {...any} args to be passed to function.
26
- @returns {Promise<any>} script return value
@@ -1,16 +0,0 @@
1
- Fills a text field or textarea, after clearing its value, with the given string.
2
- Field is located by name, label, CSS, or XPath.
3
-
4
- ```js
5
- // by label
6
- I.fillField('Email', 'hello@world.com');
7
- // by name
8
- I.fillField('password', secret('123456'));
9
- // by CSS
10
- I.fillField('form#login input[name=username]', 'John');
11
- // or by strict locator
12
- I.fillField({css: 'form#login input[name=username]'}, 'John');
13
- ```
14
- @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
15
- @param {CodeceptJS.StringOrSecret} value text value to fill.
16
- @returns {void} automatically synchronized promise through #recorder
@@ -1,13 +0,0 @@
1
- Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
2
-
3
- Examples:
4
-
5
- ```js
6
- I.dontSee('#add-to-cart-btn');
7
- I.focus('#product-tile')
8
- I.see('#add-to-cart-bnt');
9
- ```
10
-
11
- @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
12
- @param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
13
- @returns {void} automatically synchronized promise through #recorder
@@ -1,28 +0,0 @@
1
- Perform an emulated click on a link or a button, given by a locator.
2
- Unlike normal click instead of sending native event, emulates a click with JavaScript.
3
- This works on hidden, animated or inactive elements as well.
4
-
5
- If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
6
- For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
7
- For images, the "alt" attribute and inner text of any parent links are searched.
8
-
9
- The second parameter is a context (CSS or XPath locator) to narrow the search.
10
-
11
- ```js
12
- // simple link
13
- I.forceClick('Logout');
14
- // button of form
15
- I.forceClick('Submit');
16
- // CSS button
17
- I.forceClick('#form input[type=submit]');
18
- // XPath
19
- I.forceClick('//form/*[@type=submit]');
20
- // link in context
21
- I.forceClick('Logout', '#nav');
22
- // using strict locator
23
- I.forceClick({css: 'nav a.login'});
24
- ```
25
-
26
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
27
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
28
- @returns {void} automatically synchronized promise through #recorder
@@ -1,18 +0,0 @@
1
- Emulates right click on an element.
2
- Unlike normal click instead of sending native event, emulates a click with JavaScript.
3
- This works on hidden, animated or inactive elements as well.
4
-
5
- If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
6
- For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
7
- For images, the "alt" attribute and inner text of any parent links are searched.
8
-
9
- The second parameter is a context (CSS or XPath locator) to narrow the search.
10
-
11
- ```js
12
- // simple link
13
- I.forceRightClick('Menu');
14
- ```
15
-
16
- @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
17
- @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
18
- @returns {void} automatically synchronized promise through #recorder
@@ -1,7 +0,0 @@
1
- Get all Window Handles.
2
- Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
3
-
4
- ```js
5
- const windows = await I.grabAllWindowHandles();
6
- ```
7
- @returns {Promise<string[]>}
@@ -1,10 +0,0 @@
1
- Retrieves an attribute from an element located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async with `await`** operator.
3
- If more than one element is found - attribute of first element is returned.
4
-
5
- ```js
6
- let hint = await I.grabAttributeFrom('#tooltip', 'title');
7
- ```
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {string} attr attribute name.
10
- @returns {Promise<string>} attribute value
@@ -1,9 +0,0 @@
1
- Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async with `await`** operator.
3
-
4
- ```js
5
- let hints = await I.grabAttributeFromAll('.tooltip', 'title');
6
- ```
7
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
8
- @param {string} attr attribute name.
9
- @returns {Promise<string[]>} attribute value
@@ -1,9 +0,0 @@
1
- Get JS log from browser. Log buffer is reset after each request.
2
- Resumes test execution, so **should be used inside an async function with `await`** operator.
3
-
4
- ```js
5
- let logs = await I.grabBrowserLogs();
6
- console.log(JSON.stringify(logs))
7
- ```
8
-
9
- @returns {Promise<object[]>|undefined} all browser logs
@@ -1,11 +0,0 @@
1
- Gets a cookie object by name.
2
- If none provided gets all cookies.
3
- Resumes test execution, so **should be used inside async function with `await`** operator.
4
-
5
- ```js
6
- let cookie = await I.grabCookie('auth');
7
- assert(cookie.value, '123456');
8
- ```
9
-
10
- @param {?string} [name=null] cookie name.
11
- @returns {any} attribute value
@@ -1,11 +0,0 @@
1
- Grab CSS property for given locator
2
- Resumes test execution, so **should be used inside an async function with `await`** operator.
3
- If more than one element is found - value of first element is returned.
4
-
5
- ```js
6
- const value = await I.grabCssPropertyFrom('h3', 'font-weight');
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
- @param {string} cssProperty CSS property name.
11
- @returns {Promise<string>} CSS value
@@ -1,10 +0,0 @@
1
- Grab array of CSS properties for given locator
2
- Resumes test execution, so **should be used inside an async function with `await`** operator.
3
-
4
- ```js
5
- const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @param {string} cssProperty CSS property name.
10
- @returns {Promise<string[]>} CSS value
@@ -1,9 +0,0 @@
1
- Get current URL from browser.
2
- Resumes test execution, so should be used inside an async function.
3
-
4
- ```js
5
- let url = await I.grabCurrentUrl();
6
- console.log(`Current URL is [${url}]`);
7
- ```
8
-
9
- @returns {Promise<string>} current URL
@@ -1,6 +0,0 @@
1
- Get the current Window Handle.
2
- Useful for referencing it when calling `I.switchToWindow(handle)`
3
- ```js
4
- const window = await I.grabCurrentWindowHandle();
5
- ```
6
- @returns {Promise<string>}
@@ -1,20 +0,0 @@
1
- Grab the data from performance timing using Navigation Timing API.
2
- The returned data will contain following things in ms:
3
- - responseEnd,
4
- - domInteractive,
5
- - domContentLoadedEventEnd,
6
- - loadEventEnd
7
- Resumes test execution, so **should be used inside an async function with `await`** operator.
8
-
9
- ```js
10
- await I.amOnPage('https://example.com');
11
- let data = await I.grabDataFromPerformanceTiming();
12
- //Returned data
13
- { // all results are in [ms]
14
- responseEnd: 23,
15
- domInteractive: 44,
16
- domContentLoadedEventEnd: 196,
17
- loadEventEnd: 241
18
- }
19
- ```
20
- @returns {void} automatically synchronized promise through #recorder
@@ -1,20 +0,0 @@
1
- Grab the width, height, location of given locator.
2
- Provide `width` or `height`as second param to get your desired prop.
3
- Resumes test execution, so **should be used inside an async function with `await`** operator.
4
-
5
- Returns an object with `x`, `y`, `width`, `height` keys.
6
-
7
- ```js
8
- const value = await I.grabElementBoundingRect('h3');
9
- // value is like { x: 226.5, y: 89, width: 527, height: 220 }
10
- ```
11
-
12
- To get only one metric use second parameter:
13
-
14
- ```js
15
- const width = await I.grabElementBoundingRect('h3', 'width');
16
- // width == 527
17
- ```
18
- @param {LocatorOrString} locator element located by CSS|XPath|strict locator.
19
- @param {string=} elementSize x, y, width or height of the given element.
20
- @returns {Promise<DOMRect>|Promise<number>} Element bounding rectangle
@@ -1,8 +0,0 @@
1
- Return the current geo location
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let geoLocation = await I.grabGeoLocation();
6
- ```
7
-
8
- @returns {Promise<{ latitude: number, longitude: number, altitude: number }>}
@@ -1,10 +0,0 @@
1
- Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
- If more than one element is found - HTML of first element is returned.
4
-
5
- ```js
6
- let postHTML = await I.grabHTMLFrom('#post');
7
- ```
8
-
9
- @param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
10
- @returns {Promise<string>} HTML code for an element
@@ -1,9 +0,0 @@
1
- Retrieves all the innerHTML from elements located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let postHTMLs = await I.grabHTMLFromAll('.post');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
9
- @returns {Promise<string[]>} HTML code for an element
@@ -1,8 +0,0 @@
1
- Grab number of open tabs.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let tabs = await I.grabNumberOfOpenTabs();
6
- ```
7
-
8
- @returns {Promise<number>} number of open tabs
@@ -1,9 +0,0 @@
1
- Grab number of visible elements by locator.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let numOfElements = await I.grabNumberOfVisibleElements('p');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
9
- @returns {Promise<number>} number of visible elements
@@ -1,8 +0,0 @@
1
- Retrieves a page scroll position and returns it to test.
2
- Resumes test execution, so **should be used inside an async function with `await`** operator.
3
-
4
- ```js
5
- let { x, y } = await I.grabPageScrollPosition();
6
- ```
7
-
8
- @returns {Promise<PageScrollPosition>} scroll position
@@ -1,5 +0,0 @@
1
- Grab the text within the popup. If no popup is visible then it will return null.
2
- ```js
3
- await I.grabPopupText();
4
- ```
5
- @returns {Promise<string>}
@@ -1,8 +0,0 @@
1
- Retrieves page source and returns it to test.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let pageSource = await I.grabSource();
6
- ```
7
-
8
- @returns {Promise<string>} source code
@@ -1,10 +0,0 @@
1
- Retrieves a text from an element located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async with `await`** operator.
3
-
4
- ```js
5
- let pin = await I.grabTextFrom('#pin');
6
- ```
7
- If multiple elements found returns first element.
8
-
9
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
- @returns {Promise<string>} attribute value
@@ -1,9 +0,0 @@
1
- Retrieves all texts from an element located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async with `await`** operator.
3
-
4
- ```js
5
- let pins = await I.grabTextFromAll('#pin li');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @returns {Promise<string[]>} attribute value
@@ -1,8 +0,0 @@
1
- Retrieves a page title and returns it to test.
2
- Resumes test execution, so **should be used inside async with `await`** operator.
3
-
4
- ```js
5
- let title = await I.grabTitle();
6
- ```
7
-
8
- @returns {Promise<string>} title
@@ -1,9 +0,0 @@
1
- Retrieves a value from a form element located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
- If more than one element is found - value of first element is returned.
4
-
5
- ```js
6
- let email = await I.grabValueFrom('input[name=email]');
7
- ```
8
- @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
9
- @returns {Promise<string>} attribute value
@@ -1,8 +0,0 @@
1
- Retrieves an array of value from a form located by CSS or XPath and returns it to test.
2
- Resumes test execution, so **should be used inside async function with `await`** operator.
3
-
4
- ```js
5
- let inputs = await I.grabValueFromAll('//form/input');
6
- ```
7
- @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
8
- @returns {Promise<string[]>} attribute value
@@ -1,9 +0,0 @@
1
- Grab WebElement for given locator
2
- Resumes test execution, so **should be used inside an async function with `await`** operator.
3
-
4
- ```js
5
- const webElement = await I.grabWebElement('#button');
6
- ```
7
-
8
- @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
- @returns {Promise<*>} WebElement of being used Web helper