Installation

npm install --save @types/pixelmatch

Summary

This package contains type definitions for pixelmatch (https://github.com/mapbox/pixelmatch#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pixelmatch.

index.d.ts

1/// <reference types="node" />
2
3declare function Pixelmatch(
4    /** Image data of the first image to compare. Note: image dimensions must be equal. */
5    img1: Buffer | Uint8Array | Uint8ClampedArray,
6    /** Image data of the second image to compare. Note: image dimensions must be equal. */
7    img2: Buffer | Uint8Array | Uint8ClampedArray,
8    /** Image data to write the diff to, or null if don't need a diff image. */
9    output: Buffer | Uint8Array | Uint8ClampedArray | null,
10    /** Width of the images. Note that all three images need to have the same dimensions. */
11    width: number,
12    /** Height of the images. Note that all three images need to have the same dimensions. */
13    height: number,
14    /** Options. */
15    options?: Pixelmatch.PixelmatchOptions,
16): number;
17
18declare namespace Pixelmatch {
19    type RGBTuple = [number, number, number];
20
21    interface PixelmatchOptions {
22        /**
23         * Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive.
24         * @default 0.1
25         */
26        readonly threshold?: number | undefined;
27        /**
28         * If true, disables detecting and ignoring anti-aliased pixels.
29         * @default false
30         */
31        readonly includeAA?: boolean | undefined;
32        /**
33         * Blending factor of unchanged pixels in the diff output.
34         * Ranges from 0 for pure white to 1 for original brightness
35         * @default 0.1
36         */
37        alpha?: number | undefined;
38        /**
39         * The color of anti-aliased pixels in the diff output.
40         * @default [255, 255, 0]
41         */
42        aaColor?: RGBTuple | undefined;
43        /**
44         * The color of differing pixels in the diff output.
45         * @default [255, 0, 0]
46         */
47        diffColor?: RGBTuple | undefined;
48        /**
49         * An alternative color to use for dark on light differences to differentiate between "added" and "removed" parts.
50         * If not provided, all differing pixels use the color specified by `diffColor`.
51         * @default null
52         */
53        diffColorAlt?: RGBTuple | undefined;
54        /**
55         * Draw the diff over a transparent background (a mask), rather than over the original image.
56         * Will not draw anti-aliased pixels (if detected)
57         * @default false
58         */
59        diffMask?: boolean | undefined;
60    }
61}
62
63export = Pixelmatch;
64

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/node

Credits

These definitions were written by Oleg Repin, Piotr Błażejewicz, and Damian Frizzi.