diff --git a/client/cypress/README.md b/client/cypress/README.md index 7425b3ca47cd5d50ddb7e3eeaae8796d6e560a31..eee7f916eaa5d30e186b3660f1e407c95b2604e2 100644 --- a/client/cypress/README.md +++ b/client/cypress/README.md @@ -8,6 +8,7 @@ - [Prerequisites](#prerequisites) - [Test Platforms](#test-platforms) - [Test Environment Variables](#test-environment-variables) + - [Custom Commands](#custom-commands) - [Test Flow](#test-flow) - [Success Login](#success-login) - [Success Logout](#success-logout) @@ -39,6 +40,10 @@ Environment variables can be different across different machines. Machine specif Before running any tests, make sure all the variables are set correctly in `cypress.env.json`. Refer to `cypress.env.example.json` for what variables are needed. +## Custom Commands + +Cypress allows custom commands to be added via `support/command.ts`. However, an extra step is required for a TypeScript project like this one. The Cypress interface must be extended for TypeScript to correctly infer the types when adding a custom command. See `support/cypress.d.ts` for more details. + ## Test Flow ---