TestResults class

Platform: ImagesLanguage: JavaScript SDK:
Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this class is returned by the close method upon test completion.

Require statement

const {TestResults} = require('@applitools/eyes-images');
	

Methods

getAccessibilityStatus()
Returns the overall result of the accessibility test
getAppName()
Use this method to retrieve the application name.
getAppUrls()
Use this method to retrieve an object with a set of URLs that you can use to access the Test Manager in a browser, preloaded with the results of this test.
getBatchId()
Use this method to retrieve the unique batch ID of the test batch.
getBatchName()
Use this method to retrieve the batch name.
getBranchName()
Use this method to retrieve the branch name of the test.
getDuration()
Use this method to retrieve the amount of time the test ran.
getHostApp()
Use this method to retrieve the host application (browser) property of the test.
getHostDisplaySize()
Use this method to retrieve the viewport size used to identify the baseline.
getHostOS()
Use this method to retrieve the host OS property of the test.
getId()
Use this method to retrieve the ID of the test.
getIsAborted()
Use this method to retrieve whether the test was aborted or not
getIsDifferent()
Indicates that at least one step was missing, or a mismatch.
getIsNew()
Use this method to retrieve whether this is a new test or not (i.e. no existing baseline was found for this test).
getMatches()
Use this method to retrieve the number of test steps where the checkpoint image matched the baseline image.
getMismatches()
Use this method to retrieve the number of test steps where the checkpoint image did not match the baseline image. This includes new steps (i.e. steps where a baseline corresponding to the checkpoint was not found). It does not include missing steps. You can obtain this value using the getMissing method.
getMissing()
Use this method to retrieve the number of test steps where an image corresponding to the checkpoint image was not found in the baseline.
getName()
Use this method to retrieve the name of the test.
getStartedAt()
Use this method to retrieve the date and time the test started.
getStatus()
Use this method to retrieve a status that represents the results of the test.
getSteps()
Use this method to retrieve the total number of steps in the result.
getStepsInfo()
Use this method to retrieve an array of objects with information on all steps in the test.
getUrl()
Use this method to retrieve a URL which, if opened in a browser, displays the results of this test in the Test Manager.