Skip to content

doc: update module_api guide with spec error info #5910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mschile merged 3 commits into from
Aug 29, 2024
Merged

doc: update module_api guide with spec error info #5910

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98d1942
doc: update module_api guide with spec error info
mschile Aug 29, 2024
91d848e
update
mschile Aug 29, 2024
51ea302
fix lint
mschile Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guides/guides/module-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,9 @@ You can find the TypeScript definition for the results object in the

### Handling errors

Even when tests fail, the `Promise` resolves with the test results. The
`Promise` is only rejected if Cypress cannot run for some reason (for example if
Even when tests fail or a spec errors, the `Promise` resolves with the test results.
If a spec errors, the error message will be in the `runs` array under the `error` field.
The `Promise` is only rejected if Cypress cannot run for some reason (for example if
a binary has not been installed or it cannot find a module dependency). In that
case, the `Promise` will be rejected with a detailed error.

Expand Down Expand Up @@ -261,8 +262,7 @@ cypress.run({...})
process.exit(result.failures)
}

// print test results and exit
// with the number of failed tests as exit code
// exit with the number of failed tests as exit code
process.exit(result.totalFailed)
})
.catch(err => {
Expand Down