image method

Class: TargetPlatform: ImagesLanguage: JavaScript SDK:

Provide the image, or source of the image, for this target.

Syntax


eyes.check(Target.image(base64String))
eyes.check(Target.image(url))
eyes.check(Target.image(filePath))
eyes.check(Target.image(imageBuffer))

Parameters

base64String
Type:string
The checkpoint image in PNG format, encoded in base64.
url
Type:string
A string with the URL of the checkpoint image. The image must be in PNG format.
filePath
Type:string
A string with the file system path to the checkpoint image file. The image must be in PNG format.
imageBuffer
Type:Buffer
The checkpoint image as an object in PNG format.

Return value

Type: <a class ='link' href='/Content/api/eyes-sdk/index-gen/class-checksettings-images-javascript.htm'>ImagesCheckSettings</a>