Comments (5)
Correct.
In addition i also added the typings from cypress-recurse
and added jsdoc annotations for the default values.
support/index.ts
import type { RecurseDefaults } from 'cypress-recurse';
/// <reference types="cypress" />
declare global {
namespace Cypress {
interface Chainable {
/**
* @param name The name of the snapshots that will be generated
* @param testThreshold @default 0 A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
* @param retryOptions @default { limit: 0, timeout: Cypress.config('defaultCommandTimeout'), delay: Cypress.config('defaultCommandTimeout') / 5 }
* @example cy.compareSnapshot('empty-canvas', 0.1)
*/
compareSnapshot(
name: string,
testThreshold?: number,
retryOptions?: typeof RecurseDefaults
): Chainable<Element>;
}
}
}
from cypress-image-diff.
If anyone else stumbles over this issue:
support/index.ts
import './commands';
/// <reference types="cypress" />
declare global {
namespace Cypress {
interface Chainable {
/**
* @param name The name of the snapshots that will be generated
* @param testThreshold A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
* @example cy.compareSnapshot('empty-canvas', 0.1)
*/
compareSnapshot(
name: string,
testThreshold: number,
retryOptions?: {
/**
* The maximum number of retries
*/
limit: number;
/**
* Delay before next iteration in ms
*/
delay: number;
}
): Chainable<Element>;
}
}
}
from cypress-image-diff.
@Dassderdie The code comment is great!
testThreshold
should be optional?
from cypress-image-diff.
@Dassderdie if you don't mind creating a PR for this... we should have typescript support and I will work on it if no one else finds the time. Thanks a lot for sharing
from cypress-image-diff.
My TS is still complaining. Can you see what I did wrong?
// cypress/tsconfig.json
{
"compilerOptions": {
"noEmit": true,
"types": [
"cypress"
]
},
"include": [
"**/*.ts",
"../node_modules/cypress"
]
}
//test.spect.ts
it('displays two todo items by default', () => {
cy.get('#svgLayout').should('be.visible');
//TS2339: Property 'compareSnapshot' does not exist on type 'Chainable >'.
cy.get('#svgLayout').compareSnapshot('search-bar-element');
});
//support/index.ts
/// <reference types="cypress" />
import './commands';
require('cypress-terminal-report/src/installLogsCollector')();
import type { RecurseDefaults } from 'cypress-recurse';
declare global {
namespace Cypress {
interface Chainable {
/**
* @param name The name of the snapshots that will be generated
* @param testThreshold @default 0 A number between 0 and 1 that represents the allowed percentage of pixels that can be different between the two snapshots
* @param retryOptions @default { limit: 0, timeout: Cypress.config('defaultCommandTimeout'), delay: Cypress.config('defaultCommandTimeout') / 5 }
* @example cy.compareSnapshot('empty-canvas', 0.1)
*/
compareSnapshot(
name: string,
testThreshold?: number,
retryOptions?: typeof RecurseDefaults,
): Chainable<Element>;
}
}
}
//commands.ts
import '@testing-library/cypress/add-commands';
import compareSnapshotCommand from 'cypress-image-diff-js/dist/command';
compareSnapshotCommand();
from cypress-image-diff.
Related Issues (20)
- In projects with cucumber, the standard json report is not generated HOT 5
- Incorrect Difference Percentage Resulting from compareSnapshot Command HOT 6
- v1.31.0 was a breaking change HOT 3
- Add option to not take full size screenshot HOT 5
- Taken screenshots are not the size I configured HOT 10
- Option to run all tests and get diff files at once even if there are failing ones HOT 2
- Custom config file is not working HOT 14
- Cannot find module cypress-image-diff-js/dist/plugin HOT 12
- Error preparing file: cypress/support/e2e.js HOT 8
- Config "FAILURE_THRESHOLD" did not work HOT 5
- Cypress integration broken: The deleteScreenshot 'task' event has not been registered in the setupNodeEvents method. You must register it before using cy.task() HOT 4
- User config error `cypress-image-diff.config.js`
- Missing JSON report when in `cypress OPEN` mode HOT 3
- Unable to update folder locations HOT 5
- Unable to generate JSON REPORT under Folder cypress-image-diff-html-report HOT 1
- Specify shared location/path for Screenshots and Reports HOT 2
- Package subpath './dist/plugin' is not defined by "exports"... HOT 8
- Intermittent Error: ENOENT: no such file or directory, open '/a/b/foo.png'
- Error: ERR_PACKAGE_PATH_NOT_EXPORTED HOT 4
- Trying to test maps but have uggly cut offs. HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cypress-image-diff.