codeceptjs 3.5.9 → 3.5.11

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 (52) hide show
  1. package/README.md +14 -16
  2. package/docs/build/Appium.js +49 -49
  3. package/docs/build/Expect.js +33 -33
  4. package/docs/build/Nightmare.js +50 -50
  5. package/docs/build/Playwright.js +239 -133
  6. package/docs/build/Protractor.js +59 -59
  7. package/docs/build/Puppeteer.js +127 -107
  8. package/docs/build/TestCafe.js +48 -48
  9. package/docs/build/WebDriver.js +112 -93
  10. package/docs/helpers/Appium.md +3 -3
  11. package/docs/helpers/Expect.md +33 -33
  12. package/docs/helpers/Playwright.md +431 -325
  13. package/docs/helpers/Puppeteer.md +50 -24
  14. package/docs/helpers/WebDriver.md +41 -13
  15. package/docs/internal-api.md +1 -0
  16. package/docs/parallel.md +114 -2
  17. package/docs/plugins.md +7 -5
  18. package/docs/react.md +2 -1
  19. package/docs/vue.md +22 -0
  20. package/docs/webapi/grabWebElement.mustache +9 -0
  21. package/docs/webapi/grabWebElements.mustache +9 -0
  22. package/docs/webapi/scrollIntoView.mustache +1 -1
  23. package/lib/ai.js +12 -3
  24. package/lib/colorUtils.js +10 -0
  25. package/lib/command/run-multiple.js +1 -1
  26. package/lib/command/run-workers.js +30 -4
  27. package/lib/command/workers/runTests.js +39 -0
  28. package/lib/event.js +2 -0
  29. package/lib/helper/Appium.js +13 -13
  30. package/lib/helper/Expect.js +33 -33
  31. package/lib/helper/Playwright.js +125 -37
  32. package/lib/helper/Puppeteer.js +49 -38
  33. package/lib/helper/WebDriver.js +29 -19
  34. package/lib/helper/extras/PlaywrightReactVueLocator.js +38 -0
  35. package/lib/html.js +3 -3
  36. package/lib/interfaces/gherkin.js +8 -1
  37. package/lib/interfaces/scenarioConfig.js +1 -0
  38. package/lib/locator.js +2 -2
  39. package/lib/pause.js +6 -3
  40. package/lib/plugin/autoLogin.js +4 -2
  41. package/lib/plugin/heal.js +40 -7
  42. package/lib/plugin/retryFailedStep.js +6 -1
  43. package/lib/plugin/stepByStepReport.js +2 -2
  44. package/lib/plugin/tryTo.js +5 -4
  45. package/lib/recorder.js +12 -5
  46. package/lib/ui.js +1 -0
  47. package/lib/workers.js +2 -0
  48. package/package.json +28 -25
  49. package/typings/index.d.ts +1 -1
  50. package/typings/promiseBasedTypes.d.ts +195 -76
  51. package/typings/types.d.ts +191 -145
  52. package/lib/helper/extras/PlaywrightReact.js +0 -9
package/docs/helpers/Appium.md CHANGED
@@ -440,7 +440,7 @@ let settings = await I.grabSettings();
440
440
 
441
441
  Returns **[Promise][6]<[string][5]>** Appium: support Android and iOS
442
442
 
443
- ### \_switchToContext
443
+ ### switchToContext
444
444
 
445
445
  Switch to the specified context.
446
446
 
@@ -871,7 +871,7 @@ Close the given application.
871
871
  I.closeApp();
872
872
  ```
873
873
 
874
- Returns **[Promise][6]<void>** Appium: support only iOS
874
+ Returns **[Promise][6]<void>** Appium: support both Android and iOS
875
875
 
876
876
  ### appendField
877
877
 
@@ -1171,7 +1171,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
1171
1171
  #### Parameters
1172
1172
 
1173
1173
  - `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator.
1174
- - `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].
1174
+ - `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][7])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].
1175
1175
 
1176
1176
  Returns **void** automatically synchronized promise through #recorderSupported only for web testing
1177
1177
 
package/docs/helpers/Expect.md CHANGED
@@ -20,7 +20,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:
20
20
  {
21
21
  helpers: {
22
22
  Playwright: {...},
23
- ExpectHelper: {},
23
+ Expect: {},
24
24
  }
25
25
  }
26
26
  ```
@@ -32,16 +32,16 @@ Zero-configuration when paired with other helpers like REST, Playwright:
32
32
  #### Parameters
33
33
 
34
34
  - `targetData` **any**
35
- - `aboveThan` **any** number | Date
36
- - `customErrorMsg` **any**
35
+ - `aboveThan` **any**
36
+ - `customErrorMsg` **any?**
37
37
 
38
38
  ### expectBelow
39
39
 
40
40
  #### Parameters
41
41
 
42
42
  - `targetData` **any**
43
- - `belowThan` **any** number | Date
44
- - `customErrorMsg` **any**
43
+ - `belowThan` **any**
44
+ - `customErrorMsg` **any?**
45
45
 
46
46
  ### expectContain
47
47
 
@@ -49,7 +49,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:
49
49
 
50
50
  - `actualValue` **any**
51
51
  - `expectedValueToContain` **any**
52
- - `customErrorMsg` **any**
52
+ - `customErrorMsg` **any?**
53
53
 
54
54
  ### expectDeepEqual
55
55
 
@@ -57,7 +57,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:
57
57
 
58
58
  - `actualValue` **any**
59
59
  - `expectedValue` **any**
60
- - `customErrorMsg` **any**
60
+ - `customErrorMsg` **any?**
61
61
 
62
62
  ### expectDeepEqualExcluding
63
63
 
@@ -68,7 +68,7 @@ expects members of two JSON objects are deeply equal excluding some properties
68
68
  - `actualValue` **any**
69
69
  - `expectedValue` **any**
70
70
  - `fieldsToExclude` **any**
71
- - `customErrorMsg` **any**
71
+ - `customErrorMsg` **any?**
72
72
 
73
73
  ### expectDeepIncludeMembers
74
74
 
@@ -78,7 +78,7 @@ expects an array to be a superset of another array
78
78
 
79
79
  - `superset` **any**
80
80
  - `set` **any**
81
- - `customErrorMsg` **any**
81
+ - `customErrorMsg` **any?**
82
82
 
83
83
  ### expectDeepMembers
84
84
 
@@ -88,14 +88,14 @@ expects members of two arrays are deeply equal
88
88
 
89
89
  - `actualValue` **any**
90
90
  - `expectedValue` **any**
91
- - `customErrorMsg` **any**
91
+ - `customErrorMsg` **any?**
92
92
 
93
93
  ### expectEmpty
94
94
 
95
95
  #### Parameters
96
96
 
97
97
  - `targetData` **any**
98
- - `customErrorMsg` **any**
98
+ - `customErrorMsg` **any?**
99
99
 
100
100
  ### expectEndsWith
101
101
 
@@ -103,7 +103,7 @@ expects members of two arrays are deeply equal
103
103
 
104
104
  - `actualValue` **any**
105
105
  - `expectedValueToEndWith` **any**
106
- - `customErrorMsg` **any**
106
+ - `customErrorMsg` **any?**
107
107
 
108
108
  ### expectEqual
109
109
 
@@ -111,7 +111,7 @@ expects members of two arrays are deeply equal
111
111
 
112
112
  - `actualValue` **any**
113
113
  - `expectedValue` **any**
114
- - `customErrorMsg` **any**
114
+ - `customErrorMsg` **any?**
115
115
 
116
116
  ### expectEqualIgnoreCase
117
117
 
@@ -119,14 +119,14 @@ expects members of two arrays are deeply equal
119
119
 
120
120
  - `actualValue` **any**
121
121
  - `expectedValue` **any**
122
- - `customErrorMsg` **any**
122
+ - `customErrorMsg` **any?**
123
123
 
124
124
  ### expectFalse
125
125
 
126
126
  #### Parameters
127
127
 
128
128
  - `targetData` **any**
129
- - `customErrorMsg` **any**
129
+ - `customErrorMsg` **any?**
130
130
 
131
131
  ### expectHasAProperty
132
132
 
@@ -134,7 +134,7 @@ expects members of two arrays are deeply equal
134
134
 
135
135
  - `targetData` **any**
136
136
  - `propertyName` **any**
137
- - `customErrorMsg` **any**
137
+ - `customErrorMsg` **any?**
138
138
 
139
139
  ### expectHasProperty
140
140
 
@@ -142,7 +142,7 @@ expects members of two arrays are deeply equal
142
142
 
143
143
  - `targetData` **any**
144
144
  - `propertyName` **any**
145
- - `customErrorMsg` **any**
145
+ - `customErrorMsg` **any?**
146
146
 
147
147
  ### expectJsonSchema
148
148
 
@@ -150,7 +150,7 @@ expects members of two arrays are deeply equal
150
150
 
151
151
  - `targetData` **any**
152
152
  - `jsonSchema` **any**
153
- - `customErrorMsg` **any**
153
+ - `customErrorMsg` **any?**
154
154
 
155
155
  ### expectJsonSchemaUsingAJV
156
156
 
@@ -158,7 +158,7 @@ expects members of two arrays are deeply equal
158
158
 
159
159
  - `targetData` **any**
160
160
  - `jsonSchema` **any**
161
- - `customErrorMsg` **any**
161
+ - `customErrorMsg` **any?**
162
162
  - `ajvOptions` **any** Pass AJV options
163
163
 
164
164
  ### expectLengthAboveThan
@@ -167,7 +167,7 @@ expects members of two arrays are deeply equal
167
167
 
168
168
  - `targetData` **any**
169
169
  - `lengthAboveThan` **any**
170
- - `customErrorMsg` **any**
170
+ - `customErrorMsg` **any?**
171
171
 
172
172
  ### expectLengthBelowThan
173
173
 
@@ -175,7 +175,7 @@ expects members of two arrays are deeply equal
175
175
 
176
176
  - `targetData` **any**
177
177
  - `lengthBelowThan` **any**
178
- - `customErrorMsg` **any**
178
+ - `customErrorMsg` **any?**
179
179
 
180
180
  ### expectLengthOf
181
181
 
@@ -183,7 +183,7 @@ expects members of two arrays are deeply equal
183
183
 
184
184
  - `targetData` **any**
185
185
  - `length` **any**
186
- - `customErrorMsg` **any**
186
+ - `customErrorMsg` **any?**
187
187
 
188
188
  ### expectMatchesPattern
189
189
 
@@ -193,7 +193,7 @@ expects a JSON object matches a provided pattern
193
193
 
194
194
  - `actualValue` **any**
195
195
  - `expectedPattern` **any**
196
- - `customErrorMsg` **any**
196
+ - `customErrorMsg` **any?**
197
197
 
198
198
  ### expectMatchRegex
199
199
 
@@ -201,7 +201,7 @@ expects a JSON object matches a provided pattern
201
201
 
202
202
  - `targetData` **any**
203
203
  - `regex` **any**
204
- - `customErrorMsg` **any**
204
+ - `customErrorMsg` **any?**
205
205
 
206
206
  ### expectNotContain
207
207
 
@@ -209,7 +209,7 @@ expects a JSON object matches a provided pattern
209
209
 
210
210
  - `actualValue` **any**
211
211
  - `expectedValueToNotContain` **any**
212
- - `customErrorMsg` **any**
212
+ - `customErrorMsg` **any?**
213
213
 
214
214
  ### expectNotDeepEqual
215
215
 
@@ -217,7 +217,7 @@ expects a JSON object matches a provided pattern
217
217
 
218
218
  - `actualValue` **any**
219
219
  - `expectedValue` **any**
220
- - `customErrorMsg` **any**
220
+ - `customErrorMsg` **any?**
221
221
 
222
222
  ### expectNotEndsWith
223
223
 
@@ -225,7 +225,7 @@ expects a JSON object matches a provided pattern
225
225
 
226
226
  - `actualValue` **any**
227
227
  - `expectedValueToNotEndWith` **any**
228
- - `customErrorMsg` **any**
228
+ - `customErrorMsg` **any?**
229
229
 
230
230
  ### expectNotEqual
231
231
 
@@ -233,7 +233,7 @@ expects a JSON object matches a provided pattern
233
233
 
234
234
  - `actualValue` **any**
235
235
  - `expectedValue` **any**
236
- - `customErrorMsg` **any**
236
+ - `customErrorMsg` **any?**
237
237
 
238
238
  ### expectNotStartsWith
239
239
 
@@ -241,7 +241,7 @@ expects a JSON object matches a provided pattern
241
241
 
242
242
  - `actualValue` **any**
243
243
  - `expectedValueToNotStartWith` **any**
244
- - `customErrorMsg` **any**
244
+ - `customErrorMsg` **any?**
245
245
 
246
246
  ### expectStartsWith
247
247
 
@@ -249,7 +249,7 @@ expects a JSON object matches a provided pattern
249
249
 
250
250
  - `actualValue` **any**
251
251
  - `expectedValueToStartWith` **any**
252
- - `customErrorMsg` **any**
252
+ - `customErrorMsg` **any?**
253
253
 
254
254
  ### expectToBeA
255
255
 
@@ -257,7 +257,7 @@ expects a JSON object matches a provided pattern
257
257
 
258
258
  - `targetData` **any**
259
259
  - `type` **any**
260
- - `customErrorMsg` **any**
260
+ - `customErrorMsg` **any?**
261
261
 
262
262
  ### expectToBeAn
263
263
 
@@ -265,11 +265,11 @@ expects a JSON object matches a provided pattern
265
265
 
266
266
  - `targetData` **any**
267
267
  - `type` **any**
268
- - `customErrorMsg` **any**
268
+ - `customErrorMsg` **any?**
269
269
 
270
270
  ### expectTrue
271
271
 
272
272
  #### Parameters
273
273
 
274
274
  - `targetData` **any**
275
- - `customErrorMsg` **any**
275
+ - `customErrorMsg` **any?**