Skip to content

Note Cypress.Commands.add() error #5163

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
merged 5 commits into from
Apr 6, 2023
Merged

Note Cypress.Commands.add() error #5163

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f75d1b0
add callout about error
jaffrepaul Apr 5, 2023
292eb01
add PR feedback
jaffrepaul Apr 6, 2023
be80e80
lint
jaffrepaul Apr 6, 2023
f404b5e
elevate note and treat as text
jaffrepaul Apr 6, 2023
af94740
Merge branch 'main' into add-existing-commands
jaffrepaul Apr 6, 2023
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
9 changes: 9 additions & 0 deletions docs/api/cypress-api/custom-commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ Cypress comes with its own API for creating custom commands and overwriting
existing commands. The built in Cypress commands use the very same API that's
defined below.

There are two API available for adding custom commands:

- [`Cypress.Commands.add()`](#Syntax) - use to add a custom command to use when
writing tests
- [`Cypress.Command.overwrite()`](#Overwrite-Existing-Commands) - use to
override an existing built-in Cypress command or reserved internal function.
**Caution:** this overrides it for Cypress as well and could impact how
Cypress behaves.

:::info

If you want your method to have builtin
Expand Down