API Docs for: 0.2.7
Show:

BlinkDiffComparison Class

Defined in: lib/comparison/blinkdiff.js:17
Module: Helpers
Parent Module: WebDriver

Blink-Diff comparison object

Constructor

BlinkDiffComparison

(
  • driver
)

Defined in lib/comparison/blinkdiff.js:17

Parameters:

Methods

_getApprovedImagePath

(
  • title
  • [id=1]
)
String private

Defined in lib/comparison/blinkdiff.js:217

Gets the approved path for the current image

Parameters:

  • title String

    Unique title of image

  • [id=1] String optional

    Unique identifier for multiple images with the same title

Returns:

String:

_getBaseName

(
  • title
  • id
)
String private

Defined in lib/comparison/blinkdiff.js:203

Gets the name of the file-base, converting unique identifiers to filename safe strings

Parameters:

  • title String

    Unique title of image

  • id String

    Unique identifier for multiple images with the same title

Returns:

String:

_getBuildImagePath

(
  • title
  • [id=1]
)
String private

Defined in lib/comparison/blinkdiff.js:234

Gets the build path for the current image

Parameters:

  • title String

    Unique title of image

  • [id=1] String optional

    Unique identifier for multiple images with the same title

Returns:

String:

_getDiffImagePath

(
  • title
  • [id=1]
)
String private

Defined in lib/comparison/blinkdiff.js:251

Gets the difference path for the current image

Parameters:

  • title String

    Unique title of image

  • [id=1] String optional

    Unique identifier for multiple images with the same title

Returns:

String:

_getFolderName

() String private

Defined in lib/comparison/blinkdiff.js:187

Gets the name of the browser folder, categorizing screenshots from the same browser + platform

Returns:

String:

_logMethodCall

(
  • event
)
private

Defined in lib/comparison/blinkdiff.js:36

Logs a method call by an event

Parameters:

_needsApprovedSuffix

() Boolean private

Defined in lib/comparison/blinkdiff.js:268

Checks if a filename suffix is required for the approved folder

Note: This is only true if multiple file-types end up in the same folder

Returns:

Boolean:

_needsBuildSuffix

() Boolean private

Defined in lib/comparison/blinkdiff.js:286

Checks if a filename suffix is required for the build folder

Note: This is only true if multiple file-types end up in the same folder

Returns:

Boolean:

_needsDiffSuffix

() Boolean private

Defined in lib/comparison/blinkdiff.js:304

Checks if a filename suffix is required for the diff folder

Note: This is only true if multiple file-types end up in the same folder

Returns:

Boolean:

_prepareFolders

() private

Defined in lib/comparison/blinkdiff.js:340

Prepares all of the folders, creating them if needed

_requestJSON

(
  • method
  • path
  • [body]
)
private

Defined in lib/comparison/blinkdiff.js:49

Performs a context dependent JSON request for the current session. The result is parsed for errors.

Parameters:

Returns:

:

_saveBlob

(
  • filePath
  • blob
)
private

Defined in lib/comparison/blinkdiff.js:323

Saves a blob to the filesystem

Parameters:

compare

(
  • title
  • imageBlob
  • [options]
)

Defined in lib/comparison/blinkdiff.js:357

Compares a specific screenshot

Parameters:

  • title String

    Unique title of image

  • imageBlob Buffer

    Image buffer of current screenshot

  • [options] Object optional

    Comparison options

getApprovedPath

() String

Defined in lib/comparison/blinkdiff.js:157

Gets the path where approved screenshots are found

Returns:

String:

getBuildPath

() String

Defined in lib/comparison/blinkdiff.js:167

Gets the path where current screenshots will be written to

Returns:

String:

getDiffPath

() String

Defined in lib/comparison/blinkdiff.js:177

Gets the path where differences will be written to

Returns:

String:

getDriver

() Driver

Defined in lib/comparison/blinkdiff.js:69

Gets the driver object. Direct-access. No need to wait.

Returns:

Driver:

getOptions

() Object

Defined in lib/comparison/blinkdiff.js:81

Gets the default comparison options

Returns:

Object:

setup

()

Defined in lib/comparison/blinkdiff.js:427

Setup of comparison

shouldAutoApprove

() Boolean

Defined in lib/comparison/blinkdiff.js:125

Should screenshot be auto-approved?

Returns:

Boolean:

shouldBatchFailures

() Boolean

Defined in lib/comparison/blinkdiff.js:136

Batch failures until the end?

Returns:

Boolean:

shouldFailOnAdditions

() Boolean

Defined in lib/comparison/blinkdiff.js:146

Should comparison fail on additions?

Returns:

Boolean:

shouldFailOnDifference

() Boolean

Defined in lib/comparison/blinkdiff.js:108

Should an exception be thrown when there are differences?

Returns:

Boolean:

shouldOutputOnSuccess

() Boolean

Defined in lib/comparison/blinkdiff.js:91

Should an output be created when comparison is successful?

Returns:

Boolean:

tearDown

()

Defined in lib/comparison/blinkdiff.js:436

Tear-down of comparison