Class ScreenCheckResult

Encapsulates a screen capture comparison. This is the type returned by the CLI method screencheck.

Hierarchy

ScreenCheckResult

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScreenCheckResult(result?: ScreenCheckResultType, data: Buffer, referenceData?: Buffer, pixelCount?: undefined | number): ScreenCheckResult

- Defined in ScreenCheck.ts:59
Parameters
- Default value result: ScreenCheckResultType = ScreenCheckResultType.SAME
- data: Buffer
- Optional referenceData: Buffer
- Optional pixelCount: undefined | number
Returns ScreenCheckResult

Properties

data

data: Buffer

PNG data

pixelCount

pixelCount: Number

The count of pixels that missmatch between data and reference data.

Optional referenceData

referenceData: Buffer

PNG reference data

result

result: ScreenCheckResultType

The comparison result

Methods

getDiff

getDiff(): Promise<Buffer | void>

- Defined in ScreenCheck.ts:72
A PNG data buffer containing pixel data corresponding to the difference between data and reference data.

Use this method to get a render ready diff image.

Returns Promise<Buffer | void>

isDifferent

isDifferent(): boolean

- Defined in ScreenCheck.ts:92
true if result is ScreenCheckResultType.DIFFERENT

Returns boolean

isSame

isSame(): boolean

- Defined in ScreenCheck.ts:86
true if result is ScreenCheckResultType.SAME

Returns boolean

okay

okay(): void

- Defined in ScreenCheck.ts:100
Asserts result is ScreenCheckResultType.SAME

throws

AssertionError

Returns void

toString

toString(): string

- Defined in ScreenCheck.ts:80
The string representation of the result; e.g. "SAME", "DIFFERENT", "NO_BASE_IMAGE"

Returns string

Generated using TypeDoc