Jennifer Shehane
175fbc1e8d
- removed description from each api file since default is better - fixed camelcase in api page titles
1.8 KiB
title, comments
| title | comments |
|---|---|
| API | true |
{% note info New to Cypress? %} Read through our Guides first. {% endnote %}
Sections
-
Commands: Drive your tests in the browser like a real user would. They let you perform actions like typing, clicking, xhr requests, and can also assert things like "my button should be disabled".
-
Utilities: Access methods from other commonly used libraries.
-
Cypress API: Configure the behavior of how Cypress works internally. You can do things like access Environment Variables, change configuration, create custom commands, and more.
Organization
Each document attempts to cover the essentials of each method including:
-
Syntax: The method signature and any accepted arguments.
-
Usage: How to call the method including valid and invalid uses.
-
Arguments: Definition of arguments including types accepted.
-
Yields: What is yielded (and in rare cases, returned) from the method.
-
Timeout: If defined, the amount of time the method allows to execute before throwing.
-
Examples: Real world examples of using the methods.
-
Notes: Any exceptions to take into account when using the method.
-
Command Log: If and how the method displays in the Cypress Command Log and console.
-
See also: Other related methods.
Reporting a Problem
If you spot a typo, broken link, incorrect code sample or want to contribute to improve the documentation, we're happy to have your help!
To report a problem:
-
Use the 'Improve this doc' link at the top of the document.
-
Open an issue or pull request to the GitHub repository.