@types/jest-image-snapshot 6.1.0 → 6.2.1

jest-image-snapshot/README.md

@@ -8,7 +8,7 @@ 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: Tue, 06 Dec 2022 19:33:11 GMT
+ * Last updated: Fri, 15 Sep 2023 20:36:37 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
 

jest-image-snapshot/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for jest-image-snapshot 6.1
+// Type definitions for jest-image-snapshot 6.2
 // Project: https://github.com/americanexpress/jest-image-snapshot#readme
 // Definitions by: Janeene Beeforth <https://github.com/dawnmist>
 //                 erbridge <https://github.com/erbridge>
@@ -9,8 +9,8 @@
 
 /// <reference types="jest" />
 
-import { PixelmatchOptions } from 'pixelmatch';
-import { Options as SSIMOptions } from 'ssim.js';
+import { PixelmatchOptions } from "pixelmatch";
+import { Options as SSIMOptions } from "ssim.js";
 
 export interface MatchImageSnapshotOptions {
     /**
@@ -27,7 +27,7 @@ export interface MatchImageSnapshotOptions {
      * `pixelmatch` does a pixel by pixel comparison, whereas `ssim` does a structural similarity comparison.
      * @default 'pixelmatch'
      */
-    comparisonMethod?: 'pixelmatch' | 'ssim' | undefined;
+    comparisonMethod?: "pixelmatch" | "ssim" | undefined;
     /**
      * Custom snapshots directory.
      * Absolute path of a directory to keep the snapshot in.
@@ -47,6 +47,11 @@ export interface MatchImageSnapshotOptions {
      * A custom absolute path of a directory to keep this received image in.
      */
     customReceivedDir?: string | undefined;
+    /**
+     * A custom postfix which is added to the snapshot name of the received image
+     * @default '-received'
+     */
+    customReceivedPostfix?: 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
@@ -54,18 +59,18 @@ export interface MatchImageSnapshotOptions {
      */
     customSnapshotIdentifier?:
         | ((parameters: {
-              testPath: string;
-              currentTestName: string;
-              counter: number;
-              defaultIdentifier: string;
-          }) => string)
+            testPath: string;
+            currentTestName: string;
+            counter: number;
+            defaultIdentifier: string;
+        }) => string)
         | string
         | undefined;
     /**
      * Changes diff image layout direction.
      * @default 'horizontal'
      */
-    diffDirection?: 'horizontal' | 'vertical' | undefined;
+    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`).
@@ -100,7 +105,7 @@ export interface MatchImageSnapshotOptions {
      * Sets the type of threshold that would trigger a failure.
      * @default 'pixel'.
      */
-    failureThresholdType?: 'pixel' | 'percent' | undefined;
+    failureThresholdType?: "pixel" | "percent" | undefined;
     /**
      * Updates a snapshot even if it passed the threshold against the existing one.
      * @default false.

jest-image-snapshot/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/jest-image-snapshot",
-    "version": "6.1.0",
+    "version": "6.2.1",
     "description": "TypeScript definitions for jest-image-snapshot",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot",
     "license": "MIT",
@@ -39,6 +39,6 @@
         "@types/pixelmatch": "*",
         "ssim.js": "^3.1.1"
     },
-    "typesPublisherContentHash": "3b3eaea9366185a27fcafe2da000bd426b4afce1760e75ecb6568c313b602d09",
-    "typeScriptVersion": "4.3"
+    "typesPublisherContentHash": "72ef1b6e17c6e3d5f353681c9e38cbf9341ea6f5e07db39d96e4c98fbc080298",
+    "typeScriptVersion": "4.5"
 }