vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-01 15:50:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add more detail to the ResembleJS docs

Browse Source
This commit is contained in:
Tim Perry
2016-03-18 17:29:52 +01:00
parent e7a15ccfd2
commit 8efbe33282
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
resemblejs/resemblejs.d.ts vendored
View File

@@ -6,7 +6,7 @@
declare namespace Resemble {
interface ResembleStatic {
/**
* Retrieve basic analysis on one image (add compareTo to compare with another).
* Retrieve basic analysis for a single image (add compareTo to compare with another).
*/
(image: string|ImageData): ResembleAnalysis;
@@ -29,13 +29,13 @@ declare namespace Resemble {
interface ResembleAnalysis {
/**
* Run the analysis and get the result
* Run the analysis on this image and get the result
*/
onComplete(callback: (result: ResembleAnalysisResult) => void): void;
/**
* Compare this image to another image, to get resemblance data
*/
*/
compareTo(fileData: string|ImageData): ResembleComparison;
}
@@ -60,15 +60,29 @@ declare namespace Resemble {
}
interface ResembleComparisonResult {
/**
* Do the two images have the same dimensions?
*/
isSameDimensions: boolean;
/**
* The difference in width and height between the dimensions of the two compared images
*/
dimensionDifference: {
width: number;
height: number;
};
/**
* Get a data URL for the comparison image
*/
getImageDataUrl(): string;
/**
* The percentage of pixels which do not match between the images
*/
misMatchPercentage: number;
diffBounds: {
top: number;
left: number;