-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
cypress-npm-api.d.ts
345 lines (333 loc) · 7.74 KB
/
cypress-npm-api.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
//
// Cypress NPM api type declarations
// https://on.cypress.io/module-api
// https://github.com/cypress-io/cypress/issues/2141
//
// in the future the NPM module itself will be in TypeScript
// but for now describe it as an ambient module
declare module 'cypress' {
/**
* All options that one can pass to "cypress.run"
* @see https://on.cypress.io/module-api#cypress-run
* @example
```
const cypress = require('cypress')
cypress.run({
reporter: 'junit',
browser: 'chrome',
config: {
baseUrl: 'http://localhost:8080',
chromeWebSecurity: false,
},
env: {
foo: 'bar',
baz: 'quux',
}
})
```
*/
interface CypressRunOptions extends CypressCommonOptions {
/**
* Specify different browser to run tests in, either by name or by filesystem path
*/
browser: string
/**
* Specify a unique identifier for a run to enable grouping or parallelization
*/
ciBuildId: string
/**
* Group recorded tests together under a single run name
*/
group: string
/**
* Tag string for the recorded run, like "production,nightly"
*/
tag: string
/**
* Display the browser instead of running headlessly
*/
headed: boolean
/**
* Hide the browser instead of running headed
*/
headless: boolean
/**
* Specify your secret record key
*/
key: string
/**
* Keep Cypress open after all tests run
*/
noExit: boolean
/**
* Run recorded specs in parallel across multiple machines
*/
parallel: boolean
/**
* Override default port
*/
port: number
/**
* Run quietly, using only the configured reporter
*/
quiet: boolean
/**
* Whether to record the test run
*/
record: boolean
/**
* Specify a mocha reporter
*/
reporter: string
/**
* Specify mocha reporter options
*/
reporterOptions: any
/**
* Specify the specs to run
*/
spec: string
}
/**
* All options that one can pass to "cypress.open"
* @see https://on.cypress.io/module-api#cypress-open
* @example
```
const cypress = require('cypress')
cypress.open({
env: {
username: 'Joe Doe',
email: 'joe@acme.co'
},
project: '~/demos/my-project'
})
```
*/
interface CypressOpenOptions extends CypressCommonOptions {
/**
* Specify a filesystem path to a custom browser
*/
browser: string
/**
* Open Cypress in detached mode
*/
detached: boolean
/**
* Run in global mode
*/
global: boolean
/**
* Override default port
*/
port: number
}
/**
* Options available for `cypress.open` and `cypress.run`
*/
interface CypressCommonOptions {
/**
* Specify configuration
*/
config: Partial<Cypress.ResolvedConfigOptions>
/**
* Path to the config file to be used.
*
* If `false` is passed, no config file will be used.
*
* @default "cypress.json"
*/
configFile: string | false
/**
* Specify environment variables.
* TODO: isn't this duplicate of config.env?!
*/
env: object
/**
* Path to a specific project
*/
project: string
}
// small utility types to better express meaning of other types
type dateTimeISO = string
type ms = number
type hookId = string
type testId = string
type pixels = number
/**
* Cypress single test result
*/
interface TestResult {
testId: testId
title: string[]
state: string
body: string
/**
* Error stack string if there is an error
*/
stack: string | null
/**
* Error message if there is an error
*/
error: string | null
timings: any
failedFromHookId: hookId | null
wallClockStartedAt: dateTimeISO
wallClockDuration: ms
videoTimestamp: ms
}
/**
* Information about a single "before", "beforeEach", "afterEach" and "after" hook.
*/
interface HookInformation {
hookId: hookId
hookName: 'before' | 'beforeEach' | 'afterEach' | 'after'
title: string[]
body: string
}
/**
* Information about a single screenshot.
*/
interface ScreenshotInformation {
screenshotId: string
name: string
testId: testId
takenAt: dateTimeISO
/**
* Absolute path to the saved image
*/
path: string
height: pixels
width: pixels
}
/**
* Cypress test run result for a single spec.
*/
interface RunResult {
/**
* Accurate test results collected by Cypress.
*/
stats: {
suites: number
tests: number
passes: number
pending: number
skipped: number
failures: number
wallClockStartedAt: dateTimeISO
wallClockEndedAt: dateTimeISO
wallClockDuration: ms
},
/**
* Reporter name like "spec"
*/
reporter: string
/**
* This is controlled by the reporter, and Cypress cannot guarantee
* the properties. Usually this object has suites, tests, passes, etc
*/
reporterStats: object
hooks: HookInformation[]
tests: TestResult[]
error: string | null
video: string | null
screenshots: ScreenshotInformation[]
/**
* information about the spec test file.
*/
spec: {
/**
* filename like "spec.js"
*/
name: string
/**
* name relative to the project root, like "cypress/integration/spec.js"
*/
relative: string
/**
* resolved filename of the spec
*/
absolute: string
},
shouldUploadVideo: boolean
}
/**
* Results returned by the test run.
* @see https://on.cypress.io/module-api
*/
interface CypressRunResult {
startedTestsAt: dateTimeISO
endedTestsAt: dateTimeISO
totalDuration: ms
totalSuites: number
totalTests: number
totalFailed: number
totalPassed: number
totalPending: number
totalSkipped: number
/**
* If Cypress test run is being recorded, full url will be provided.
* @see https://on.cypress.io/dashboard-introduction
*/
runUrl?: string
runs: RunResult[]
browserPath: string
browserName: string
browserVersion: string
osName: string
osVersion: string
cypressVersion: string
config: Cypress.ResolvedConfigOptions
}
/**
* If Cypress fails to run at all (for example, if there are no spec files to run),
* then it will return a CypressFailedRunResult. Check the failures attribute.
* @example
```
const result = await cypress.run()
if (result.failures) {
console.error(result.message)
process.exit(result.failures)
}
```
*
**/
interface CypressFailedRunResult {
failures: number
message: string
}
/**
* Cypress NPM module interface.
* @see https://on.cypress.io/module-api
* @example
```
const cypress = require('cypress')
cypress.run().then(results => ...)
```
*/
interface CypressNpmApi {
/**
* Execute a headless Cypress test run.
* @see https://on.cypress.io/module-api#cypress-run
* @example
```
const cypress = require('cypress')
// runs all spec files matching a wildcard
cypress.run({
spec: 'cypress/integration/admin*-spec.js'
}).then(results => {
// inspect results object
})
```
*/
run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult | CypressFailedRunResult>,
/**
* Opens Cypress GUI. Resolves with void when the
* GUI is closed.
* @see https://on.cypress.io/module-api#cypress-open
*/
open(options?: Partial<CypressOpenOptions>): Promise<void>
}
// export Cypress NPM module interface
const cypress: CypressNpmApi
export = cypress
}