Skip to content

DiffResult

Defined in: packages/image/src/options.ts:14

The outcome of comparing a baseline and a current screenshot.

baselineDimensions: object

Defined in: packages/image/src/options.ts:24

Dimensions of the baseline image.

height: number

width: number


currentDimensions: object

Defined in: packages/image/src/options.ts:26

Dimensions of the current image.

height: number

width: number


diffImage: Buffer<ArrayBufferLike> | null

Defined in: packages/image/src/options.ts:22

Generated diff overlay image, or null when unavailable.


diffPixels: number

Defined in: packages/image/src/options.ts:18

Number of differing pixels.


diffRatio: number

Defined in: packages/image/src/options.ts:20

Ratio of differing pixels to total pixels.


passed: boolean

Defined in: packages/image/src/options.ts:16

Whether the current image is within the accepted tolerance.


sizeChanged: boolean

Defined in: packages/image/src/options.ts:28

Whether the two images have different dimensions.