Target class

Platform: ImagesLanguage: JavaScript SDK:

This class provides methods that are used to define and configure the checkpoint target for the check method.

Once you create a ImagesCheckSettings object using one of the factory methods defined by this class, you can configure the checkpoint by calling other methods from the ImagesCheckSettings class, chaining them one after the other using the '.' operator.

Require statement

const {Target} = require('@applitools/eyes-images');

Methods

base64(): Provide the image as a base64 encoded string.

buffer(): Provide the checkpoint image in an in-memory buffer.

image(): Provide the image, or source of the image, for this target.

path(): Provide the file system path to a file containing the checkpoint image.

region(): Configure check to match a region in the checkpoint image, instead of the entire image.

url(): Provide the URI of an image to use as the checkpoint image.