Add dumpDiffToConsole to MatchImageSnapshotOptions (#43738)

* Add dumpDiffToConsole to MatchImageSnapshotOptions

* Update jest-image-snapshot version reference

* Remove patch version
This commit is contained in:
Jeff Rooks 2020-04-13 16:52:50 -07:00 committed by GitHub
parent f410f756a0
commit bf2417889d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,4 +1,4 @@
// Type definitions for jest-image-snapshot 2.11
// Type definitions for jest-image-snapshot 2.12
// Project: https://github.com/americanexpress/jest-image-snapshot#readme
// Definitions by: Janeene Beeforth <https://github.com/dawnmist>
// erbridge <https://github.com/erbridge>
@ -48,6 +48,11 @@ export interface MatchImageSnapshotOptions {
* Changes diff image layout direction, default is horizontal.
*/
diffDirection?: 'horizontal' | 'vertical';
/**
* Will output base64 string of a diff image to console in case of failed tests (in addition to creating a diff image).
* This string can be copy-pasted to a browser address string to preview the diff for a failed test.
*/
dumpDiffToConsole?: boolean;
/**
* Removes coloring from the console output, useful if storing the results to a file.
* Defaults to false.