@types/jest-image-snapshot 4.3.0 → 5.1.0

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: Fri, 26 Feb 2021 15:59:06 GMT
+ * Last updated: Fri, 24 Jun 2022 07:31:36 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)
  * Global values: none
 

jest-image-snapshot/index.d.ts

@@ -1,12 +1,13 @@
-// Type definitions for jest-image-snapshot 4.3
+// Type definitions for jest-image-snapshot 5.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>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 3.8
+// Minimum TypeScript Version: 4.3
 
 /// <reference types="jest" />
+
 import { PixelmatchOptions } from 'pixelmatch';
 import { Options as SSIMOptions } from 'ssim.js';
 
@@ -15,26 +16,36 @@ export interface MatchImageSnapshotOptions {
      * If set to true, the build will not fail when the screenshots to compare have different sizes.
      * @default false
      */
-    allowSizeMismatch?: boolean;
+    allowSizeMismatch?: boolean | undefined;
     /**
      * Custom config passed to 'pixelmatch' or 'ssim'
      */
-    customDiffConfig?: PixelmatchOptions | Partial<SSIMOptions>;
+    customDiffConfig?: PixelmatchOptions | Partial<SSIMOptions> | undefined;
     /**
      * The method by which images are compared.
      * `pixelmatch` does a pixel by pixel comparison, whereas `ssim` does a structural similarity comparison.
      * @default 'pixelmatch'
      */
-    comparisonMethod?: 'pixelmatch' | 'ssim';
+    comparisonMethod?: 'pixelmatch' | 'ssim' | undefined;
     /**
      * Custom snapshots directory.
      * Absolute path of a directory to keep the snapshot in.
      */
-    customSnapshotsDir?: string;
+    customSnapshotsDir?: string | undefined;
     /**
      * A custom absolute path of a directory to keep this diff in
      */
-    customDiffDir?: string;
+    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,58 +58,59 @@ export interface MatchImageSnapshotOptions {
               counter: number;
               defaultIdentifier: string;
           }) => string)
-        | string;
+        | string
+        | undefined;
     /**
      * Changes diff image layout direction.
      * @default 'horizontal'
      */
-    diffDirection?: 'horizontal' | 'vertical';
+    diffDirection?: 'horizontal' | 'vertical' | 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.
      * @default false
      */
-    dumpDiffToConsole?: boolean;
+    dumpDiffToConsole?: boolean | undefined;
     /**
      * Will output the image to the terminal using iTerm's Inline Images Protocol.
      * If the term is not compatible, it does the same thing as `dumpDiffToConsole`.
      * @default false
      */
-    dumpInlineDiffToConsole?: boolean;
+    dumpInlineDiffToConsole?: boolean | undefined;
     /**
      * Removes coloring from the console output, useful if storing the results to a file.
      * @default false.
      */
-    noColors?: boolean;
+    noColors?: boolean | undefined;
     /**
      * Sets the threshold that would trigger a test failure based on the failureThresholdType selected. This is different
      * to the customDiffConfig.threshold above - the customDiffConfig.threshold is the per pixel failure threshold, whereas
      * this is the failure threshold for the entire comparison.
      * @default 0.
      */
-    failureThreshold?: number;
+    failureThreshold?: number | undefined;
     /**
      * Sets the type of threshold that would trigger a failure.
      * @default 'pixel'.
      */
-    failureThresholdType?: 'pixel' | 'percent';
+    failureThresholdType?: 'pixel' | 'percent' | undefined;
     /**
      * Updates a snapshot even if it passed the threshold against the existing one.
      * @default false.
      */
-    updatePassedSnapshot?: boolean;
+    updatePassedSnapshot?: boolean | undefined;
     /**
      * Applies Gaussian Blur on compared images, accepts radius in pixels as value. Useful when you have noise after
      * scaling images per different resolutions on your target website, usually setting its value to 1-2 should be
      * enough to solve that problem.
      * @default 0.
      */
-    blur?: number;
+    blur?: number | undefined;
     /**
      * Runs the diff in process without spawning a child process.
      * @default false.
      */
-    runInProcess?: boolean;
+    runInProcess?: boolean | undefined;
 }
 
 /**

jest-image-snapshot/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@types/jest-image-snapshot",
-    "version": "4.3.0",
+    "version": "5.1.0",
     "description": "TypeScript definitions for jest-image-snapshot",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot",
     "license": "MIT",
     "contributors": [
         {
@@ -33,6 +34,6 @@
         "@types/pixelmatch": "*",
         "ssim.js": "^3.1.1"
     },
-    "typesPublisherContentHash": "d027b95b142fe32bf7dde079cdecb9b17580aac643c8d260c7b7cb69ab6a5ecc",
-    "typeScriptVersion": "3.8"
+    "typesPublisherContentHash": "d482cc53ade896f7d9d914a0f169c33fae0bfd438a70796b67f2f0e468b3086d",
+    "typeScriptVersion": "4.3"
 }