Skip to content
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.

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

add instruction for adding types to tsconfig #494

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ Then add to your `cypress/support/index.js` file
import '@percy/cypress'
```

If you are using typescript, add the following to your `tsconfig.json`

```ts
{
...
"compilerOptions": {
"types": [..., "@percy/cypress"],
...
},
...
}
```

## Usage

This is an example using the `cy.percySnapshot` command.
Expand Down