@types/jest-image-snapshot 4.3.2 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
jest-image-snapshot/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for jest-image-snapshot (https://github.c
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated: Fri,
|
|
11
|
+
* Last updated: Fri, 24 Jun 2022 07:31:36 GMT
|
|
12
12
|
* Dependencies: [@types/pixelmatch](https://npmjs.com/package/@types/pixelmatch), [@types/ssim.js](https://npmjs.com/package/@types/ssim.js), [@types/jest](https://npmjs.com/package/@types/jest)
|
|
13
13
|
* Global values: none
|
|
14
14
|
|
jest-image-snapshot/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Type definitions for jest-image-snapshot
|
|
1
|
+
// Type definitions for jest-image-snapshot 5.1
|
|
2
2
|
// Project: https://github.com/americanexpress/jest-image-snapshot#readme
|
|
3
3
|
// Definitions by: Janeene Beeforth <https://github.com/dawnmist>
|
|
4
4
|
// erbridge <https://github.com/erbridge>
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
// Minimum TypeScript Version: 4.3
|
|
8
8
|
|
|
9
9
|
/// <reference types="jest" />
|
|
10
|
+
|
|
10
11
|
import { PixelmatchOptions } from 'pixelmatch';
|
|
11
12
|
import { Options as SSIMOptions } from 'ssim.js';
|
|
12
13
|
|
|
@@ -35,6 +36,16 @@ export interface MatchImageSnapshotOptions {
|
|
|
35
36
|
* A custom absolute path of a directory to keep this diff in
|
|
36
37
|
*/
|
|
37
38
|
customDiffDir?: string | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* Store the received images separately from the composed diff images on failure.
|
|
41
|
+
* This can be useful when updating baseline images from CI.
|
|
42
|
+
* @default false
|
|
43
|
+
*/
|
|
44
|
+
storeReceivedOnFailure?: boolean | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* A custom absolute path of a directory to keep this received image in.
|
|
47
|
+
*/
|
|
48
|
+
customReceivedDir?: string | undefined;
|
|
38
49
|
/**
|
|
39
50
|
* A custom name to give this snapshot. If not provided, one is computed automatically. When a function is provided
|
|
40
51
|
* it is called with an object containing testPath, currentTestName, counter and defaultIdentifier as its first
|
|
@@ -47,7 +58,8 @@ export interface MatchImageSnapshotOptions {
|
|
|
47
58
|
counter: number;
|
|
48
59
|
defaultIdentifier: string;
|
|
49
60
|
}) => string)
|
|
50
|
-
| string
|
|
61
|
+
| string
|
|
62
|
+
| undefined;
|
|
51
63
|
/**
|
|
52
64
|
* Changes diff image layout direction.
|
|
53
65
|
* @default 'horizontal'
|
jest-image-snapshot/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/jest-image-snapshot",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.1.0",
|
|
4
4
|
"description": "TypeScript definitions for jest-image-snapshot",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot",
|
|
6
6
|
"license": "MIT",
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"@types/pixelmatch": "*",
|
|
35
35
|
"ssim.js": "^3.1.1"
|
|
36
36
|
},
|
|
37
|
-
"typesPublisherContentHash": "
|
|
37
|
+
"typesPublisherContentHash": "d482cc53ade896f7d9d914a0f169c33fae0bfd438a70796b67f2f0e468b3086d",
|
|
38
38
|
"typeScriptVersion": "4.3"
|
|
39
39
|
}
|