check method

Class: EyesPlatform: NightwatchLanguage: 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 CheckSettings class.


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

let result = await eyes.check(checkSettings_lit);

let result = await eyes.check();



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.

A series of method calls to the CheckSettings class, in Fluent API style.

Type:CheckSettingsPlain [Optional ]

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

A literal object defined by the CheckSettingsPlain object.

Return value

Type: Promise<MatchResult>


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