@types/jest-image-snapshot 2.12.2 → 3.1.0

jest-image-snapshot v2.12/README.md → jest-image-snapshot/README.md

@@ -5,12 +5,12 @@
 This package contains type definitions for jest-image-snapshot (https://github.com/americanexpress/jest-image-snapshot#readme).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot/v2.
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-image-snapshot.
 
 ### Additional Details
- * Last updated: Tue, 20 Oct 2020 07:15:44 GMT
+ * Last updated: Wed, 13 May 2020 18:41:00 GMT
  * Dependencies: [@types/jest](https://npmjs.com/package/@types/jest)
  * Global values: none
 
 # Credits
-These definitions were written by [Janeene Beeforth](https://github.com/dawnmist), and [erbridge](https://github.com/erbridge).
+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).

jest-image-snapshot v2.12/index.d.ts → jest-image-snapshot/index.d.ts

@@ -1,9 +1,10 @@
-// Type definitions for jest-image-snapshot 2.12
+// Type definitions for jest-image-snapshot 3.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
+// TypeScript Version: 3.1
 
 /// <reference types="jest" />
 
@@ -11,13 +12,25 @@
  * Options to be passed to the 'pixelmatch' image diffing function.
  */
 export interface PixelmatchOptions {
-    /** Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0.1 by default. */
+    /**
+     * Matching threshold, ranges from 0 to 1.
+     * Smaller values make the comparison more sensitive.
+     * @default 0.1
+     */
     readonly threshold?: number;
-    /** If true, disables detecting and ignoring anti-aliased pixels. false by default. */
+    /**
+     * If true, disables detecting and ignoring anti-aliased pixels.
+     * @default false
+     */
     readonly includeAA?: boolean;
 }
 
 export interface MatchImageSnapshotOptions {
+    /**
+     * If set to true, the build will not fail when the screenshots to compare have different sizes.
+     * @default false
+     */
+    allowSizeMismatch?: boolean;
     /**
      * Custom config passed to 'pixelmatch'
      */
@@ -45,46 +58,48 @@ export interface MatchImageSnapshotOptions {
           }) => string)
         | string;
     /**
-     * Changes diff image layout direction, default is horizontal.
+     * Changes diff image layout direction.
+     * @default '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.
+     * @default false
      */
     dumpDiffToConsole?: boolean;
     /**
      * Removes coloring from the console output, useful if storing the results to a file.
-     * Defaults to false.
+     * @default false.
      */
     noColors?: boolean;
     /**
      * 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.
-     * Defaults to 0.
+     * @default 0.
      */
     failureThreshold?: number;
     /**
      * Sets the type of threshold that would trigger a failure.
-     * Defaults to 'pixel'.
+     * @default 'pixel'.
      */
     failureThresholdType?: 'pixel' | 'percent';
     /**
      * Updates a snapshot even if it passed the threshold against the existing one.
-     * Defaults to false.
+     * @default false.
      */
     updatePassedSnapshot?: boolean;
     /**
      * 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 it's value to 1-2 should be
+     * scaling images per different resolutions on your target website, usually setting its value to 1-2 should be
      * enough to solve that problem.
-     * Defaults to 0.
+     * @default 0.
      */
     blur?: number;
     /**
      * Runs the diff in process without spawning a child process.
-     * Defaults to false.
+     * @default false.
      */
     runInProcess?: boolean;
 }

jest-image-snapshot v2.12/package.json → jest-image-snapshot/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/jest-image-snapshot",
-    "version": "2.12.2",
+    "version": "3.1.0",
     "description": "TypeScript definitions for jest-image-snapshot",
     "license": "MIT",
     "contributors": [
@@ -13,6 +13,11 @@
             "name": "erbridge",
             "url": "https://github.com/erbridge",
             "githubUsername": "erbridge"
+        },
+        {
+            "name": "Piotr Błażejewicz",
+            "url": "https://github.com/peterblazejewicz",
+            "githubUsername": "peterblazejewicz"
         }
     ],
     "main": "",
@@ -26,6 +31,6 @@
     "dependencies": {
         "@types/jest": "*"
     },
-    "typesPublisherContentHash": "f44ef6612b2c559811026725f58e5a307c42cb61b17c3c49855fd2b20447c580",
-    "typeScriptVersion": "3.8"
+    "typesPublisherContentHash": "2a3b66bc3ee82b1dec8b0ca7e6b71d51891a9564cf27712db173c4a8474eb4f7",
+    "typeScriptVersion": "3.1"
 }