cy.compareSnapshot command

All available options for compareSnapshot command

cy.compareSnapshot command could be use in a most basic way:

cy.compareSnapshot('header')

or in a more configurable way:

cy.compareSnapshot({
  name: 'header',
  testThreshold: 0.2
})

• Available options are:

Option	Type	Required/Default value	Description
name	string	required	The name of the snapshots that will be generated
nameTemplate	string	undefined	The snapshot naming pattern. Same as NAME_TEMPLATE, but with higher precedence
testThreshold	number	0	A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
retryOptions	Partial<RecurseDefaults>	{ limit:1 }	Config objects passed to cypress-recurse
exactName	boolean	false	If set to true, will use the given name as it is without transforming it to [spec_file_name]-[name]
cypressScreenshotOptions	Partial<Cypress.ScreenshotOptions & Cypress.Loggable & Cypress.Timeoutable>	undefined	options object to change the default behavior of cy.screenshot()