@types/jest-image-snapshot 4.3.2 → 6.1.0

jest-image-snapshot/README.md

@@ -8,9 +8,9 @@ This package contains type definitions for jest-image-snapshot (https://github.c
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot.
 
 ### Additional Details
- * Last updated: Fri, 17 Jun 2022 12:01:40 GMT
- * 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)
+ * Last updated: Tue, 06 Dec 2022 19:33:11 GMT
+ * Dependencies: [@types/jest](https://npmjs.com/package/@types/jest), [@types/pixelmatch](https://npmjs.com/package/@types/pixelmatch), [@types/ssim.js](https://npmjs.com/package/@types/ssim.js)
  * Global values: none
 
 # Credits
-These definitions were written by [Janeene Beeforth](https://github.com/dawnmist), [erbridge](https://github.com/erbridge), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).
+These definitions were written by [Janeene Beeforth](https://github.com/dawnmist), [erbridge](https://github.com/erbridge), [Piotr Błażejewicz](https://github.com/peterblazejewicz), and [Ayc0](https://github.com/Ayc0).

jest-image-snapshot/index.d.ts

@@ -1,12 +1,14 @@
-// Type definitions for jest-image-snapshot 4.3
+// Type definitions for jest-image-snapshot 6.1
 // Project: https://github.com/americanexpress/jest-image-snapshot#readme
 // Definitions by: Janeene Beeforth <https://github.com/dawnmist>
 //                 erbridge <https://github.com/erbridge>
 //                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
+//                 Ayc0 <https://github.com/Ayc0>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // Minimum TypeScript Version: 4.3
 
 /// <reference types="jest" />
+
 import { PixelmatchOptions } from 'pixelmatch';
 import { Options as SSIMOptions } from 'ssim.js';
 
@@ -35,6 +37,16 @@ export interface MatchImageSnapshotOptions {
      * A custom absolute path of a directory to keep this diff in
      */
     customDiffDir?: string | undefined;
+    /**
+     * Store the received images separately from the composed diff images on failure.
+     * This can be useful when updating baseline images from CI.
+     * @default false
+     */
+    storeReceivedOnFailure?: boolean | undefined;
+    /**
+     * A custom absolute path of a directory to keep this received image in.
+     */
+    customReceivedDir?: string | undefined;
     /**
      * A custom name to give this snapshot. If not provided, one is computed automatically. When a function is provided
      * it is called with an object containing testPath, currentTestName, counter and defaultIdentifier as its first
@@ -47,12 +59,19 @@ export interface MatchImageSnapshotOptions {
               counter: number;
               defaultIdentifier: string;
           }) => string)
-        | string | undefined;
+        | string
+        | undefined;
     /**
      * Changes diff image layout direction.
      * @default 'horizontal'
      */
     diffDirection?: 'horizontal' | 'vertical' | undefined;
+    /**
+     * Either only include the difference between the baseline and the received image in the diff image, or include
+     * the 3 images (following the direction set by `diffDirection`).
+     * @default false
+     */
+    onlyDiff?: boolean | undefined;
     /**
      * 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.

jest-image-snapshot/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/jest-image-snapshot",
-    "version": "4.3.2",
+    "version": "6.1.0",
     "description": "TypeScript definitions for jest-image-snapshot",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot",
     "license": "MIT",
@@ -19,6 +19,11 @@
             "name": "Piotr Błażejewicz",
             "url": "https://github.com/peterblazejewicz",
             "githubUsername": "peterblazejewicz"
+        },
+        {
+            "name": "Ayc0",
+            "url": "https://github.com/Ayc0",
+            "githubUsername": "Ayc0"
         }
     ],
     "main": "",
@@ -34,6 +39,6 @@
         "@types/pixelmatch": "*",
         "ssim.js": "^3.1.1"
     },
-    "typesPublisherContentHash": "277626488fee3bae14a01955a856b857a40a72852b36c48245e8f32312929d6a",
+    "typesPublisherContentHash": "3b3eaea9366185a27fcafe2da000bd426b4afce1760e75ecb6568c313b602d09",
     "typeScriptVersion": "4.3"
 }