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

setMatchTimeout method

Class: EyesPlatform: Selenium 4Language: JavaScript SDK:

Use this method to set the maximum time Eyes will try to perform a match on the fully captured image.

Since a browser can take time to render a page (because it is complex, or because of slow network speeds), if Eyes detects mismatches, it will initially assume that the mismatch is because the render has not completed yet, and it will retry the match after a short wait. You can use this method to determine how much time Eyes spends retrying the matching before declaring a mismatch.

Syntax

eyes.setMatchTimeout(matchTimeout);

Parameters

matchTimeout
Type:number
The timeout to set in milliseconds.

Return value

Type: void

Remarks

You can overide the default timeout set by this method for a specific set checkpoint by passing a timeout to one of the check_XXXX methods that support a timeout parameter, e.g. eyes$checkwindowYou can also overide the timeout for a specific test using the check fluent checksettings$timeout