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

check method

Class: EyesPlatform: ImagesLanguage: 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 as a parameter. First, choose a method from the Target class, then, optionally, chain one or more methods from the ImagesCheckSettings class.


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



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.

The fluent API calls, starting with one of the Target methods.

Return value

Type: Promise<boolean>
A return value of true indicates that the checkpoint matched, or is a new checkpoint. The meaning of a return value of false depends on whether this is the first checkpoint to return this value or not. For the first checkpoint that returns a value of false, the implication is that there was a mismatch. The test may choose to recapture the image and resend it (when using a check that supports this feature). Once one checkpoint has returned false, all the following checkpoints will also return false. This does not mean that the checkpoint mismatched; it means that Eyes will only know the final status of the checkpoint at the end of the test. If required, the actual result of the checkpoint should be obtained from the StepInfo object in the TestResults returned by the close method.


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