API Docs for: 0.2.7
Show:

Comparison Class

Defined in: lib/helpers/comparison.js:9
Module: Helpers
Parent Module: WebDriver

Comparison object

Constructor

Comparison

(
  • driver
  • comparisonList
)

Defined in lib/helpers/comparison.js:9

Parameters:

  • driver Driver
  • comparisonList String[]

    List of tools to use for comparison

Methods

_compare

(
  • plugins
  • title
  • imageBlob
  • options
)
private

Defined in lib/helpers/comparison.js:133

Uses a list comparison plugins to compare a screenshot

Parameters:

_getCompareList

() String[] private

Defined in lib/helpers/comparison.js:159

Gets a list of comparison plugins

Returns:

String[]:

_loadComparison

(
  • name
)
private

Defined in lib/helpers/comparison.js:77

Loads a specific comparison plugin

Parameters:

_logMethodCall

(
  • event
)
private

Defined in lib/helpers/comparison.js:33

Logs a method call by an event

Parameters:

_requestJSON

(
  • method
  • path
  • [body]
)
private

Defined in lib/helpers/comparison.js:46

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

Parameters:

Returns:

:

compare

(
  • title
  • imageBlob
  • [options]
)

Defined in lib/helpers/comparison.js:109

Compares a specific screenshot with all comparison plugins

Parameters:

  • title String

    Unique title of image

  • imageBlob Buffer

    Image buffer of current screenshot

  • [options] Object optional

    Comparison options

getComparison

(
  • name
)
BlinkDiffComparison

Defined in lib/helpers/comparison.js:98

Gets a specific comparison tool by name

Parameters:

Returns:

BlinkDiffComparison:

tearDown

()

Defined in lib/helpers/comparison.js:179

Tear-down of comparison plugins