The information in this topic may be out of date. The current SDK reference guide has moved here.

check method

Class: EyesPlatform: Selenium 3Language: JavaScript SDK:

Run a checkpoint. Uses Fluent arguments to specify the various parameters.

To define the region of the check point, and to configure special processing, pass a chain of method calls from the Target class as the target parameter.


let result = await eyes.check(name, target);



The tag defines a name for the checkpoint in the Eyes Test Manager. The name may be any string and serves to identify the step to the user in the Test manager. You may change the tag value without impacting testing in any way since Eyes does not use the tag to identify the baseline step that corresponds to the checkpoint - Eyes matches steps based on their content and position in the sequences of images of the test. See How Eyes compares checkpoints and baseline images for details.

t b d what this is

Return value

Type: Promise<boolean>


For a detailed description of how to use this method see The Eyes SDK check Fluent API.