-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.d.ts
51 lines (46 loc) · 1.71 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
declare namespace Cypress {
interface Chainable<Subject> {
/**
* Take a screenshot using SmartBears VisualTest.
*
* @see https://support.smartbear.com/visualtest/docs/sdks/cypress.html
*
* @param {string} imageName
*
*
* @param {Object} options
* @param {string} options.capture - viewport or fullpage (for an element: chain off of cy.get)
* @param {string} options.comparisonMode - layout or detailed
* @param {string} options.sensitivity - how strict the comparison engine will be on the image (required if comparisonMode is 'layout')
* @param {number} options.lazyload - milliseconds each scroll will take for the page to fully load
* @param {string[]} options.ignoreElements - array of CssSelectors to ignore on the comparison
*
*
*
* @example
* cy.sbvtCapture("homepage", {
* comparisonMode: "layout",
* sensitivity: "medium"
* })
* */
sbvtCapture(imageName: string, options?: {
capture?: 'viewport' | 'fullpage';
lazyload?: number;
comparisonMode?: 'layout' | 'detailed';
sensitivity?: 'low' | 'medium' | 'high';
ignoreElements?: string[];
}): Chainable<any>;
}
interface Chainable<Subject> {
/**
* Print out the comparison engine response from this test run.
* */
sbvtPrintReport(): void;
}
interface Chainable<Subject> {
/**
* Returns the comparison engine response from this test run.
**/
sbvtGetTestRunResult(): Chainable<any>;
}
}