Skip to content

docs: hint to typescript matcher extensions in image snapshots #8537

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 1 commit into from
Closed

docs: hint to typescript matcher extensions in image snapshots #8537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/guide/snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ It will compare with the content of `./test/basic.output.html`. And can be writt

## Image Snapshots

It's also possible to snapshot images using [`jest-image-snapshot`](https://github.com/americanexpress/jest-image-snapshot).
It's also possible to snapshot images using [`jest-image-snapshot`](https://github.com/americanexpress/jest-image-snapshot). When using Typescript, you will need to [extend the `Assertion` interface](/guide/extending-matchers.html).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't really explain anything. If you need to have types for this package, you just need to have @types/jest-image-snapshot installed. This is something that should be explained by the package itself

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jest-image-snapshot users need to use expect.extend, which unfortunately doesn't add typing. However, going over their docs again, there is a section mentioning the necessity to add a matcher. I will close the PR as the package docs (partially) explain how to do it.


```bash
npm i -D jest-image-snapshot
Expand Down