Skip to content

Adding an existing command or reserved internal function with Cypress.Commands.add() will throw an error #4178

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

Closed
wants to merge 2 commits into from
Closed

Adding an existing command or reserved internal function with Cypress.Commands.add() will throw an error #4178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7184c25
update custom commands docs
davidmunechika Oct 26, 2021
de92f29
add internal function to alert
davidmunechika Nov 16, 2021
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
6 changes: 6 additions & 0 deletions content/api/cypress-api/custom-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,12 @@ Log? Read more about [Command Logging](#Command-Logging).

</Alert>

<Alert type="warning">

Note that `Cypress.Commands.add()` will throw an error when trying to add a custom command with the same name as an existing built-in Cypress command or reserved internal function. In order to override the behavior of an existing command, `Cypress.Commands.overwrite()` should be used instead. For more information, read the section [Overwrite Existing Commands](#Overwrite-Existing-Commands).

</Alert>

### Child Commands

Child commands are always chained off of a **parent** command, or another
Expand Down