Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/pixelmatch
Advanced tools
@types/pixelmatch - npm Package Compare versions
Comparing version 5.2.4 to 5.2.5
@@ -1,8 +0,1 @@ | ||
| // Type definitions for pixelmatch 5.2 | ||
| // Project: https://github.com/mapbox/pixelmatch#readme | ||
| // Definitions by: Oleg Repin <https://github.com/iamolegga> | ||
| // Piotr Błażejewicz <https://github.com/peterblazejewicz> | ||
| // Damian Frizzi <https://github.com/damianfrizzi> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
| /// <reference types="node" /> | ||
@@ -9,0 +2,0 @@ |
| { | ||
| "name": "@types/pixelmatch", | ||
| "version": "5.2.4", | ||
| "version": "5.2.5", | ||
| "description": "TypeScript definitions for pixelmatch", | ||
@@ -10,14 +10,14 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pixelmatch", | ||
| "name": "Oleg Repin", | ||
| "url": "https://github.com/iamolegga", | ||
| "githubUsername": "iamolegga" | ||
| "githubUsername": "iamolegga", | ||
| "url": "https://github.com/iamolegga" | ||
| }, | ||
| { | ||
| "name": "Piotr Błażejewicz", | ||
| "url": "https://github.com/peterblazejewicz", | ||
| "githubUsername": "peterblazejewicz" | ||
| "githubUsername": "peterblazejewicz", | ||
| "url": "https://github.com/peterblazejewicz" | ||
| }, | ||
| { | ||
| "name": "Damian Frizzi", | ||
| "url": "https://github.com/damianfrizzi", | ||
| "githubUsername": "damianfrizzi" | ||
| "githubUsername": "damianfrizzi", | ||
| "url": "https://github.com/damianfrizzi" | ||
| } | ||
@@ -36,4 +36,4 @@ ], | ||
| }, | ||
| "typesPublisherContentHash": "653616cda3bc484e1f534342f9433c89bcfb5858bcb6f96d0317c4f4274783ae", | ||
| "typeScriptVersion": "3.6" | ||
| "typesPublisherContentHash": "3bb122b2583043c0aed0c3986ec342ee9f8d5ac7bf7e748a8fd664ee3583829e", | ||
| "typeScriptVersion": "4.5" | ||
| } |
@@ -9,9 +9,75 @@ # Installation | ||
| Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pixelmatch. | ||
| ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pixelmatch/index.d.ts) | ||
| ````ts | ||
| /// <reference types="node" /> | ||
| declare function Pixelmatch( | ||
| /** Image data of the first image to compare. Note: image dimensions must be equal. */ | ||
| img1: Buffer | Uint8Array | Uint8ClampedArray, | ||
| /** Image data of the second image to compare. Note: image dimensions must be equal. */ | ||
| img2: Buffer | Uint8Array | Uint8ClampedArray, | ||
| /** Image data to write the diff to, or null if don't need a diff image. */ | ||
| output: Buffer | Uint8Array | Uint8ClampedArray | null, | ||
| /** Width of the images. Note that all three images need to have the same dimensions. */ | ||
| width: number, | ||
| /** Height of the images. Note that all three images need to have the same dimensions. */ | ||
| height: number, | ||
| /** Options. */ | ||
| options?: Pixelmatch.PixelmatchOptions, | ||
| ): number; | ||
| declare namespace Pixelmatch { | ||
| type RGBTuple = [number, number, number]; | ||
| interface PixelmatchOptions { | ||
| /** | ||
| * Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. | ||
| * @default 0.1 | ||
| */ | ||
| readonly threshold?: number | undefined; | ||
| /** | ||
| * If true, disables detecting and ignoring anti-aliased pixels. | ||
| * @default false | ||
| */ | ||
| readonly includeAA?: boolean | undefined; | ||
| /** | ||
| * Blending factor of unchanged pixels in the diff output. | ||
| * Ranges from 0 for pure white to 1 for original brightness | ||
| * @default 0.1 | ||
| */ | ||
| alpha?: number | undefined; | ||
| /** | ||
| * The color of anti-aliased pixels in the diff output. | ||
| * @default [255, 255, 0] | ||
| */ | ||
| aaColor?: RGBTuple | undefined; | ||
| /** | ||
| * The color of differing pixels in the diff output. | ||
| * @default [255, 0, 0] | ||
| */ | ||
| diffColor?: RGBTuple | undefined; | ||
| /** | ||
| * An alternative color to use for dark on light differences to differentiate between "added" and "removed" parts. | ||
| * If not provided, all differing pixels use the color specified by `diffColor`. | ||
| * @default null | ||
| */ | ||
| diffColorAlt?: RGBTuple | undefined; | ||
| /** | ||
| * Draw the diff over a transparent background (a mask), rather than over the original image. | ||
| * Will not draw anti-aliased pixels (if detected) | ||
| * @default false | ||
| */ | ||
| diffMask?: boolean | undefined; | ||
| } | ||
| } | ||
| export = Pixelmatch; | ||
| ```` | ||
| ### Additional Details | ||
| * Last updated: Wed, 07 Jul 2021 17:02:30 GMT | ||
| * Last updated: Wed, 18 Oct 2023 05:47:08 GMT | ||
| * Dependencies: [@types/node](https://npmjs.com/package/@types/node) | ||
| * Global values: none | ||
| # Credits | ||
| These definitions were written by [Oleg Repin](https://github.com/iamolegga), [Piotr Błażejewicz](https://github.com/peterblazejewicz), and [Damian Frizzi](https://github.com/damianfrizzi). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by37.19%
7868
- Number of lines in readme file
- increased by388.24%
83
Worsened metrics
- Lines of code
- decreased by-9.23%
59
No dependency changes