codeceptjs 3.3.5-beta.6 → 3.3.6

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 (160) hide show
  1. package/CHANGELOG.md +69 -2
  2. package/bin/codecept.js +40 -3
  3. package/docs/basics.md +24 -1
  4. package/docs/build/Appium.js +41 -22
  5. package/docs/build/FileSystem.js +1 -1
  6. package/docs/build/Nightmare.js +106 -57
  7. package/docs/build/Playwright.js +187 -111
  8. package/docs/build/Protractor.js +132 -70
  9. package/docs/build/Puppeteer.js +143 -76
  10. package/docs/build/REST.js +2 -2
  11. package/docs/build/TestCafe.js +107 -57
  12. package/docs/build/WebDriver.js +162 -89
  13. package/docs/changelog.md +107 -2
  14. package/docs/commands.md +5 -3
  15. package/docs/community-helpers.md +7 -4
  16. package/docs/configuration.md +5 -5
  17. package/docs/examples.md +39 -48
  18. package/docs/helpers/Appium.md +25 -23
  19. package/docs/helpers/FileSystem.md +1 -1
  20. package/docs/helpers/Nightmare.md +57 -57
  21. package/docs/helpers/Playwright.md +76 -75
  22. package/docs/helpers/Puppeteer.md +76 -85
  23. package/docs/helpers/REST.md +1 -1
  24. package/docs/helpers/TestCafe.md +57 -57
  25. package/docs/helpers/WebDriver.md +84 -97
  26. package/docs/quickstart.md +1 -1
  27. package/docs/reports.md +1 -1
  28. package/docs/secrets.md +1 -1
  29. package/docs/typescript.md +9 -69
  30. package/docs/webapi/appendField.mustache +1 -1
  31. package/docs/webapi/attachFile.mustache +3 -3
  32. package/docs/webapi/checkOption.mustache +1 -1
  33. package/docs/webapi/clearCookie.mustache +1 -1
  34. package/docs/webapi/clearField.mustache +1 -1
  35. package/docs/webapi/click.mustache +1 -1
  36. package/docs/webapi/clickLink.mustache +1 -1
  37. package/docs/webapi/closeCurrentTab.mustache +1 -1
  38. package/docs/webapi/closeOtherTabs.mustache +1 -1
  39. package/docs/webapi/dontSee.mustache +1 -1
  40. package/docs/webapi/dontSeeCheckboxIsChecked.mustache +1 -1
  41. package/docs/webapi/dontSeeCookie.mustache +1 -1
  42. package/docs/webapi/dontSeeCurrentUrlEquals.mustache +1 -1
  43. package/docs/webapi/dontSeeElement.mustache +1 -1
  44. package/docs/webapi/dontSeeElementInDOM.mustache +1 -1
  45. package/docs/webapi/dontSeeInCurrentUrl.mustache +1 -1
  46. package/docs/webapi/dontSeeInField.mustache +1 -1
  47. package/docs/webapi/dontSeeInSource.mustache +1 -1
  48. package/docs/webapi/dontSeeInTitle.mustache +1 -1
  49. package/docs/webapi/doubleClick.mustache +1 -1
  50. package/docs/webapi/downloadFile.mustache +1 -1
  51. package/docs/webapi/dragAndDrop.mustache +1 -1
  52. package/docs/webapi/dragSlider.mustache +1 -1
  53. package/docs/webapi/executeAsyncScript.mustache +1 -1
  54. package/docs/webapi/executeScript.mustache +1 -1
  55. package/docs/webapi/fillField.mustache +1 -1
  56. package/docs/webapi/forceClick.mustache +1 -1
  57. package/docs/webapi/forceRightClick.mustache +1 -1
  58. package/docs/webapi/moveCursorTo.mustache +1 -1
  59. package/docs/webapi/openNewTab.mustache +1 -1
  60. package/docs/webapi/pressKey.mustache +1 -1
  61. package/docs/webapi/pressKeyDown.mustache +1 -1
  62. package/docs/webapi/pressKeyUp.mustache +1 -1
  63. package/docs/webapi/pressKeyWithKeyNormalization.mustache +1 -1
  64. package/docs/webapi/refreshPage.mustache +1 -1
  65. package/docs/webapi/resizeWindow.mustache +1 -1
  66. package/docs/webapi/rightClick.mustache +1 -1
  67. package/docs/webapi/saveElementScreenshot.mustache +2 -2
  68. package/docs/webapi/saveScreenshot.mustache +2 -2
  69. package/docs/webapi/say.mustache +1 -1
  70. package/docs/webapi/scrollIntoView.mustache +1 -1
  71. package/docs/webapi/scrollPageToBottom.mustache +1 -1
  72. package/docs/webapi/scrollPageToTop.mustache +1 -1
  73. package/docs/webapi/scrollTo.mustache +1 -1
  74. package/docs/webapi/see.mustache +1 -1
  75. package/docs/webapi/seeAttributesOnElements.mustache +1 -1
  76. package/docs/webapi/seeCheckboxIsChecked.mustache +1 -1
  77. package/docs/webapi/seeCookie.mustache +1 -1
  78. package/docs/webapi/seeCssPropertiesOnElements.mustache +1 -1
  79. package/docs/webapi/seeCurrentUrlEquals.mustache +1 -1
  80. package/docs/webapi/seeElement.mustache +1 -1
  81. package/docs/webapi/seeElementInDOM.mustache +1 -1
  82. package/docs/webapi/seeInCurrentUrl.mustache +1 -1
  83. package/docs/webapi/seeInField.mustache +1 -1
  84. package/docs/webapi/seeInPopup.mustache +1 -1
  85. package/docs/webapi/seeInSource.mustache +1 -1
  86. package/docs/webapi/seeInTitle.mustache +1 -1
  87. package/docs/webapi/seeNumberOfElements.mustache +1 -1
  88. package/docs/webapi/seeNumberOfVisibleElements.mustache +1 -1
  89. package/docs/webapi/seeTextEquals.mustache +1 -1
  90. package/docs/webapi/seeTitleEquals.mustache +1 -1
  91. package/docs/webapi/selectOption.mustache +1 -1
  92. package/docs/webapi/setCookie.mustache +1 -1
  93. package/docs/webapi/setGeoLocation.mustache +1 -1
  94. package/docs/webapi/switchTo.mustache +1 -1
  95. package/docs/webapi/switchToNextTab.mustache +1 -1
  96. package/docs/webapi/switchToPreviousTab.mustache +1 -1
  97. package/docs/webapi/type.mustache +1 -1
  98. package/docs/webapi/uncheckOption.mustache +1 -1
  99. package/docs/webapi/wait.mustache +1 -1
  100. package/docs/webapi/waitForClickable.mustache +1 -1
  101. package/docs/webapi/waitForDetached.mustache +1 -1
  102. package/docs/webapi/waitForElement.mustache +1 -1
  103. package/docs/webapi/waitForEnabled.mustache +1 -1
  104. package/docs/webapi/waitForFunction.mustache +1 -1
  105. package/docs/webapi/waitForInvisible.mustache +1 -1
  106. package/docs/webapi/waitForText.mustache +1 -1
  107. package/docs/webapi/waitForValue.mustache +1 -1
  108. package/docs/webapi/waitForVisible.mustache +1 -1
  109. package/docs/webapi/waitInUrl.mustache +1 -1
  110. package/docs/webapi/waitNumberOfVisibleElements.mustache +1 -1
  111. package/docs/webapi/waitToHide.mustache +1 -1
  112. package/docs/webapi/waitUrlEquals.mustache +1 -1
  113. package/lib/command/configMigrate.js +1 -1
  114. package/lib/command/dryRun.js +2 -1
  115. package/lib/command/generate.js +35 -18
  116. package/lib/command/run-rerun.js +38 -0
  117. package/lib/command/utils.js +13 -3
  118. package/lib/config.js +2 -2
  119. package/lib/data/context.js +7 -0
  120. package/lib/helper/Appium.js +6 -4
  121. package/lib/helper/FileSystem.js +1 -1
  122. package/lib/helper/Nightmare.js +1 -1
  123. package/lib/helper/Playwright.js +48 -38
  124. package/lib/helper/Protractor.js +1 -1
  125. package/lib/helper/REST.js +2 -2
  126. package/lib/helper/TestCafe.js +1 -1
  127. package/lib/helper/WebDriver.js +7 -7
  128. package/lib/plugin/wdio.js +11 -2
  129. package/lib/utils.js +3 -0
  130. package/package.json +2 -2
  131. package/typings/index.d.ts +46 -46
  132. package/typings/types.d.ts +497 -443
  133. package/docs/wiki/.git/FETCH_HEAD +0 -1
  134. package/docs/wiki/.git/HEAD +0 -1
  135. package/docs/wiki/.git/ORIG_HEAD +0 -1
  136. package/docs/wiki/.git/config +0 -11
  137. package/docs/wiki/.git/description +0 -1
  138. package/docs/wiki/.git/hooks/applypatch-msg.sample +0 -15
  139. package/docs/wiki/.git/hooks/commit-msg.sample +0 -24
  140. package/docs/wiki/.git/hooks/fsmonitor-watchman.sample +0 -173
  141. package/docs/wiki/.git/hooks/post-update.sample +0 -8
  142. package/docs/wiki/.git/hooks/pre-applypatch.sample +0 -14
  143. package/docs/wiki/.git/hooks/pre-commit.sample +0 -49
  144. package/docs/wiki/.git/hooks/pre-merge-commit.sample +0 -13
  145. package/docs/wiki/.git/hooks/pre-push.sample +0 -53
  146. package/docs/wiki/.git/hooks/pre-rebase.sample +0 -169
  147. package/docs/wiki/.git/hooks/pre-receive.sample +0 -24
  148. package/docs/wiki/.git/hooks/prepare-commit-msg.sample +0 -42
  149. package/docs/wiki/.git/hooks/push-to-checkout.sample +0 -78
  150. package/docs/wiki/.git/hooks/update.sample +0 -128
  151. package/docs/wiki/.git/index +0 -0
  152. package/docs/wiki/.git/info/exclude +0 -6
  153. package/docs/wiki/.git/logs/HEAD +0 -1
  154. package/docs/wiki/.git/logs/refs/heads/master +0 -1
  155. package/docs/wiki/.git/logs/refs/remotes/origin/HEAD +0 -1
  156. package/docs/wiki/.git/objects/pack/pack-5938044f9d30daf1c195fda4dec1d54850933935.idx +0 -0
  157. package/docs/wiki/.git/objects/pack/pack-5938044f9d30daf1c195fda4dec1d54850933935.pack +0 -0
  158. package/docs/wiki/.git/packed-refs +0 -2
  159. package/docs/wiki/.git/refs/heads/master +0 -1
  160. package/docs/wiki/.git/refs/remotes/origin/HEAD +0 -1
@@ -74,7 +74,7 @@ Answer questions, agree on defaults, when asked to select helpers choose **Playw
74
74
  ? What helpers do you want to use?
75
75
  ❯◉ Playwright
76
76
  ◯ WebDriver
77
- Protractor
77
+ Puppeteer
78
78
  ◯ Puppeteer
79
79
  ◯ Appium
80
80
  ◯ Nightmare
package/docs/reports.md CHANGED
@@ -342,7 +342,7 @@ Then tests with failure will have screenshots.
342
342
 
343
343
  ### Configuration
344
344
 
345
- This helper should be configured in codecept.json
345
+ This helper should be configured in codecept.conf.ts
346
346
 
347
347
  - `uniqueScreenshotNames` (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites. This option should be the same as in common helper.
348
348
  - `disableScreenshots` (optional, default: false) - don't save screenshot on failure. This option should be the same as in common helper.
package/docs/secrets.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Secrets
2
2
 
3
- It is possible to mask out sensitive data when passing it to steps. This is important when filling password fields, or sending secure keys to API endpoint.
3
+ It is possible to **mask out sensitive data** when passing it to steps. This is important when filling password fields, or sending secure keys to API endpoint.
4
4
 
5
5
  Wrap data in `secret` function to mask sensitive values in output and logs.
6
6
 
@@ -25,84 +25,24 @@ Example:
25
25
  - incorrectly used CodeceptJS features;
26
26
 
27
27
 
28
- ## Getting Started
28
+ ## Getting Started <Badge text="Since 3.3.5" type="warning"/>
29
29
 
30
- ### TypeScript Boilerplate
31
-
32
- To get started faster we prepared [typescript boilerplate project](https://github.com/codeceptjs/typescript-boilerplate) which can be used instead of configuring TypeScript on your own. Clone this repository into an empty folder and you are done.
33
-
34
- Otherwise, follow next steps to introduce TypeScript into the project.
35
-
36
- ### Install TypeScipt
37
-
38
- For writing tests in TypeScript you'll need to install `typescript` and `ts-node` into your project.
30
+ CodeceptJS can initialize tests as a TypeScript project.
31
+ When starting a new project with a standard installation via
39
32
 
40
33
  ```
41
- npm install typescript ts-node
42
- ```
43
-
44
- ### Configure codecept.conf.js
45
-
46
- To configure TypeScript in your project, you need to add [`ts-node/register`](https://github.com/TypeStrong/ts-node) on first line in your config. Like in the following config file:
34
+ npx codeceptjs init
35
+ ```
36
+ Then select TypeScript as the first question:
47
37
 
48
- ```js
49
- require('ts-node/register')
50
-
51
- exports.config = {
52
- tests: './*_test.ts',
53
- output: './output',
54
- helpers: {
55
- Puppeteer: {
56
- url: 'http://example.com',
57
- },
58
- },
59
- name: 'project name',
60
- }
61
38
  ```
62
-
63
- ### Configure tsconfig.json
64
-
65
- We recommended the following configuration in a [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html):
66
-
67
- ```json
68
- {
69
- "ts-node": {
70
- "files": true
71
- },
72
- "compilerOptions": {
73
- "target": "es2018",
74
- "lib": ["es2018", "DOM"],
75
- "esModuleInterop": true,
76
- "module": "commonjs",
77
- "strictNullChecks": true,
78
- "types": ["codeceptjs"],
79
- },
80
- }
39
+ ? Do you plan to write tests in TypeScript? Yes
81
40
  ```
82
41
 
83
- > You can find an example project with TypeScript and CodeceptJS on our project [typescript-boilerplate](https://github.com/codeceptjs/typescript-boilerplate).
84
-
85
- ### Set Up steps.d.ts
86
-
87
- Configuring the `tsconfig.json` and `codecept.conf.js` is not enough, you will need to configure the `steps.d.ts` file for custom steps. Just simply do this by running this command::
42
+ Then a config file and new tests will be created in TypeScript format.
88
43
 
89
- `npx codeceptjs def`
44
+ If a config file is set in TypeScrip format (`codecept.conf.ts`) package `node-ts` will be used to run tests.
90
45
 
91
- As a result, a file will be created on your root folder with following content:
92
-
93
- ```ts
94
- /// <reference types='codeceptjs' />
95
-
96
- declare namespace CodeceptJS {
97
- interface SupportObject { I: I }
98
- interface Methods extends Puppeteer {}
99
- interface I extends WithTranslation<Methods> {}
100
- namespace Translation {
101
- interface Actions {}
102
- }
103
- }
104
-
105
- ```
106
46
 
107
47
  ## Types for custom helper or page object
108
48
 
@@ -6,4 +6,4 @@ I.appendField('#myTextField', 'appended');
6
6
  ```
7
7
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
8
8
  @param {string} value text value to append.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,5 +1,5 @@
1
1
  Attaches a file to element located by label, name, CSS or XPath
2
- Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
2
+ Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
3
3
  File will be uploaded to remote system (if tests are running remotely).
4
4
 
5
5
  ```js
@@ -8,5 +8,5 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
8
8
  ```
9
9
 
10
10
  @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
11
- @param {string} pathToFile local file path relative to codecept.json config file.
12
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ @param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -10,4 +10,4 @@ I.checkOption('agree', '//form');
10
10
  ```
11
11
  @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
12
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
13
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.clearCookie('test');
7
7
  ```
8
8
 
9
9
  @param {?string} [cookie=null] (optional, `null` by default) cookie name
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -6,4 +6,4 @@ I.clearField('user[email]');
6
6
  I.clearField('#email');
7
7
  ```
8
8
  @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder.
@@ -22,4 +22,4 @@ I.click({css: 'nav a.login'});
22
22
 
23
23
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
24
24
  @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
25
- [!] returns a _promise_ which is synchronized internally by recorder
25
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.clickLink('Logout', '#nav');
5
5
  ```
6
6
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
7
7
  @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -4,4 +4,4 @@ Close current tab.
4
4
  I.closeCurrentTab();
5
5
  ```
6
6
 
7
- [!] returns a _promise_ which is synchronized internally by recorder
7
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ Close all tabs except for the current one.
5
5
  I.closeOtherTabs();
6
6
  ```
7
7
 
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
8
8
 
9
9
  @param {string} text which is not present.
10
10
  @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
11
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
7
7
  ```
8
8
 
9
9
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.dontSeeCookie('auth'); // no auth cookie
5
5
  ```
6
6
 
7
7
  @param {string} name cookie name.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
7
7
  ```
8
8
 
9
9
  @param {string} url value to check.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.dontSeeElement('.modal'); // modal is not shown
5
5
  ```
6
6
 
7
7
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
5
5
  ```
6
6
 
7
7
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,4 +1,4 @@
1
1
  Checks that current url does not contain a provided fragment.
2
2
 
3
3
  @param {string} url value to check.
4
- [!] returns a _promise_ which is synchronized internally by recorder
4
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
8
8
 
9
9
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
10
  @param {string} value value to check.
11
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.dontSeeInSource('<!--'); // no comments in source
5
5
  ```
6
6
 
7
7
  @param {string} value to check.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.dontSeeInTitle('Error');
5
5
  ```
6
6
 
7
7
  @param {string} text value to check.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -10,4 +10,4 @@ I.doubleClick('.btn.edit');
10
10
 
11
11
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
12
12
  @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
13
- [!] returns a _promise_ which is synchronized internally by recorder
13
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.downloadFile('td[class="text-right file-link"] a', 'thisIsCustomName');
9
9
 
10
10
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by CSS|XPath locator.
11
11
  @param {string} file custom file name.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -6,4 +6,4 @@ I.dragAndDrop('#dragHandle', '#container');
6
6
 
7
7
  @param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
8
8
  @param {LocatorOrString} destElement located by CSS|XPath|strict locator.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.dragSlider('#slider', -70);
8
8
 
9
9
  @param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
10
10
  @param {number} offsetX position to drag.
11
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -21,4 +21,4 @@ let val = await I.executeAsyncScript(function(url, done) {
21
21
 
22
22
  @param {string|function} fn function to be executed in browser context.
23
23
  @param {...any} args to be passed to function.
24
- [!] returns a _promise_ which is synchronized internally by recorder
24
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -23,4 +23,4 @@ let date = await I.executeScript(function(el) {
23
23
 
24
24
  @param {string|function} fn function to be executed in browser context.
25
25
  @param {...any} args to be passed to function.
26
- [!] returns a _promise_ which is synchronized internally by recorder
26
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -13,4 +13,4 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
13
13
  ```
14
14
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
15
15
  @param {CodeceptJS.StringOrSecret} value text value to fill.
16
- [!] returns a _promise_ which is synchronized internally by recorder
16
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -25,4 +25,4 @@ I.forceClick({css: 'nav a.login'});
25
25
 
26
26
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
27
27
  @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
28
- [!] returns a _promise_ which is synchronized internally by recorder
28
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -15,4 +15,4 @@ I.forceRightClick('Menu');
15
15
 
16
16
  @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
17
17
  @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
18
- [!] returns a _promise_ which is synchronized internally by recorder
18
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.moveCursorTo('#submit', 5,5);
9
9
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
10
10
  @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
11
11
  @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -4,4 +4,4 @@ Open new tab and switch to it.
4
4
  I.openNewTab();
5
5
  ```
6
6
 
7
- [!] returns a _promise_ which is synchronized internally by recorder
7
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.pressKey(['Control','a']);
9
9
  ```
10
10
 
11
11
  @param {string|string[]} key key or array of keys to press.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.pressKeyUp('Control');
9
9
  ```
10
10
 
11
11
  @param {string} key name of key to press down.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.pressKeyUp('Control');
9
9
  ```
10
10
 
11
11
  @param {string} key name of key to release.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -57,4 +57,4 @@ Some of the supported key names are:
57
57
  - `'Tab'`
58
58
 
59
59
  @param {string|string[]} key key or array of keys to press.
60
- [!] returns a _promise_ which is synchronized internally by recorder
60
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -3,4 +3,4 @@ Reload the current page.
3
3
  ```js
4
4
  I.refreshPage();
5
5
  ```
6
- [!] returns a _promise_ which is synchronized internally by recorder
6
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -3,4 +3,4 @@ First parameter can be set to `maximize`.
3
3
 
4
4
  @param {number} width width in pixels or `maximize`.
5
5
  @param {number} height height in pixels.
6
- [!] returns a _promise_ which is synchronized internally by recorder
6
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -11,4 +11,4 @@ I.rightClick('Click me', '.context');
11
11
 
12
12
  @param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
13
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
14
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,4 +1,4 @@
1
- Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
1
+ Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
2
2
  Filename is relative to output folder.
3
3
 
4
4
  ```js
@@ -7,4 +7,4 @@ I.saveElementScreenshot(`#submit`,'debug.png');
7
7
 
8
8
  @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
9
  @param {string} fileName file name to save.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -1,4 +1,4 @@
1
- Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
1
+ Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
2
2
  Filename is relative to output folder.
3
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
4
 
@@ -9,4 +9,4 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
9
9
 
10
10
  @param {string} fileName file name to save.
11
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
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.say('This is by default'); //cyan is used
7
7
  ```
8
8
  @param {string} text expected on console log.
9
9
  @param {string} [color='cyan'] color you want to use.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
8
8
 
9
9
  @param {LocatorOrString} locator located by CSS|XPath|strict locator.
10
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
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -3,4 +3,4 @@ Scroll page to the bottom.
3
3
  ```js
4
4
  I.scrollPageToBottom();
5
5
  ```
6
- [!] returns a _promise_ which is synchronized internally by recorder
6
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -3,4 +3,4 @@ Scroll page to the top.
3
3
  ```js
4
4
  I.scrollPageToTop();
5
5
  ```
6
- [!] returns a _promise_ which is synchronized internally by recorder
6
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.scrollTo('#submit', 5, 5);
9
9
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
10
10
  @param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
11
11
  @param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.see('Register', {css: 'form.register'}); // use strict locator
8
8
  ```
9
9
  @param {string} text expected on page.
10
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
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -6,4 +6,4 @@ I.seeAttributesOnElements('//form', { method: "post"});
6
6
 
7
7
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
8
  @param {object} attributes attributes and their values to check.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
7
7
  ```
8
8
 
9
9
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.seeCookie('Auth');
5
5
  ```
6
6
 
7
7
  @param {string} name cookie name.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -6,4 +6,4 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
6
6
 
7
7
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
8
  @param {object} cssProperties object with CSS properties and their values to check.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
8
8
  ```
9
9
 
10
10
  @param {string} url value to check.
11
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ Element is located by CSS or XPath.
5
5
  I.seeElement('#modal');
6
6
  ```
7
7
  @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ Element is located by CSS or XPath.
5
5
  I.seeElementInDOM('#modal');
6
6
  ```
7
7
  @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.seeInCurrentUrl('/register'); // we are on registration page
5
5
  ```
6
6
 
7
7
  @param {string} url a fragment to check
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.seeInField('#searchform input','Search');
9
9
  ```
10
10
  @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
11
11
  @param {string} value value to check.
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ given string.
5
5
  I.seeInPopup('Popup text');
6
6
  ```
7
7
  @param {string} text value to check.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -4,4 +4,4 @@ Checks that the current page contains the given string in its raw source code.
4
4
  I.seeInSource('<h1>Green eggs &amp; ham</h1>');
5
5
  ```
6
6
  @param {string} text value to check.
7
- [!] returns a _promise_ which is synchronized internally by recorder
7
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.seeInTitle('Home Page');
5
5
  ```
6
6
 
7
7
  @param {string} text text value to check.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -8,4 +8,4 @@ I.seeNumberOfElements('#submitBtn', 1);
8
8
 
9
9
  @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
10
10
  @param {number} num number of elements.
11
- [!] returns a _promise_ which is synchronized internally by recorder
11
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -7,4 +7,4 @@ I.seeNumberOfVisibleElements('.buttons', 3);
7
7
 
8
8
  @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
9
9
  @param {number} num number of elements.
10
- [!] returns a _promise_ which is synchronized internally by recorder
10
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -6,4 +6,4 @@ I.seeTextEquals('text', 'h1');
6
6
 
7
7
  @param {string} text element value to check.
8
8
  @param {CodeceptJS.LocatorOrString?} [context=null] element located by CSS|XPath|strict locator.
9
- [!] returns a _promise_ which is synchronized internally by recorder
9
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -5,4 +5,4 @@ I.seeTitleEquals('Test title.');
5
5
  ```
6
6
 
7
7
  @param {string} text value to check.
8
- [!] returns a _promise_ which is synchronized internally by recorder
8
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -18,4 +18,4 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
18
18
  ```
19
19
  @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
20
20
  @param {string|Array<*>} option visible text or value of option.
21
- [!] returns a _promise_ which is synchronized internally by recorder
21
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -13,4 +13,4 @@ I.setCookie([
13
13
  ```
14
14
 
15
15
  @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
16
- [!] returns a _promise_ which is synchronized internally by recorder
16
+ ⚠️ returns a _promise_ which is synchronized internally by recorder
@@ -9,4 +9,4 @@ I.setGeoLocation(121.21, 11.56, 10);
9
9
  @param {number} latitude to set.
10
10
  @param {number} longitude to set
11
11
  @param {number=} altitude (optional, null by default) to set
12
- [!] returns a _promise_ which is synchronized internally by recorder
12
+ ⚠️ returns a _promise_ which is synchronized internally by recorder