diff --git a/phantomcss/phantomcss-tests.ts b/phantomcss/phantomcss-tests.ts
index e3c066c6a..d555017ed 100644
--- a/phantomcss/phantomcss-tests.ts
+++ b/phantomcss/phantomcss-tests.ts
@@ -4,7 +4,7 @@
// phantomCSS 0.11.1 is based on resemblejs 1.2.1, phantomJS 1.9.2 , casperJS 1.1.0-DEV
-var options: PhantomCSSOptions = {
+var options: PhantomCSS.PhantomCSSOptions = {
libraryRoot: './modules/PhantomCSS',
screenshotRoot: './screenshots',
@@ -60,6 +60,7 @@ var options: PhantomCSSOptions = {
rebase: null//casper.cli.get("rebase")
}
+declare var phantomcss:PhantomCSS.PhantomCSS;
phantomcss.turnOffAnimations();
phantomcss.init(options);
diff --git a/phantomcss/phantomcss.d.ts b/phantomcss/phantomcss.d.ts
index 3afd4b7fd..98c5c3732 100644
--- a/phantomcss/phantomcss.d.ts
+++ b/phantomcss/phantomcss.d.ts
@@ -5,88 +5,87 @@
///
///
-
-interface PhantomCSS{
+declare module PhantomCSS {
+ interface PhantomCSS {
+ init(options: PhantomCSSOptions): void;
+ update(options: PhantomCSSOptions): void;
- init(options:PhantomCSSOptions):void;
- update( options:PhantomCSSOptions):void;
-
- /**
- * Take a screenshot of the targeted HTML element
- * FileName is required if addIteratorToImage option is set to false
- */
- screenshot(target:string, fileName?:string ):void;
+ /**
+ * Take a screenshot of the targeted HTML element
+ * FileName is required if addIteratorToImage option is set to false
+ */
+ screenshot(target: string, fileName?: string): void;
- /**
- * Take a screenshot of the targeted HTML element
- * FileName is required if addIteratorToImage option is set to false
- */
- screenshot(target:ClipRect, fileName?:string):void;
- /**
- * Take a screenshot of the targeted HTML element
- * FileName is required if addIteratorToImage option is set to false
- */
- screenshot( target:string, timeToWait:number, hideSelector:string, fileName?:string ):void;
-
- compareAll( exclude:string ):void;
- compareAll( exclude:string, diffList:string[], include:string ):void;
- compareMatched( match:string, exclude:string ):void;
- compareMatched( match:RegExp, exclude:RegExp ):void;
- /**
- * Explicitly define what files you want to compare
- */
- compareExplicit( list:string[] ):void;
- /**
- * Compare image diffs generated in this test run only
- */
- compareSession( list?:any[] ):void;
- compareFiles( baseFile:string, diffFiles:string ):PhantomCSSTest;
- waitForTests( tests:PhantomCSSTest[] ):void;
- done():void;
- /**
- * Turn off CSS transitions and jQuery animations
- */
- turnOffAnimations():void;
- getExitStatus():number;
- /**
- * Get a list of image diffs generated in this test run
- */
- getCreatedDiffFiles():Array;
-}
+ /**
+ * Take a screenshot of the targeted HTML element
+ * FileName is required if addIteratorToImage option is set to false
+ */
+ screenshot(target: ClipRect, fileName?: string): void;
+ /**
+ * Take a screenshot of the targeted HTML element
+ * FileName is required if addIteratorToImage option is set to false
+ */
+ screenshot(target: string, timeToWait: number, hideSelector: string, fileName?: string): void;
-interface PhantomCSSTest{
- filename? : string;
- error?: boolean;
- fail?:boolean;
- success?:boolean;
- failFile?:string;
- mismatch?:any;
-}
+ compareAll(exclude: string): void;
+ compareAll(exclude: string, diffList: string[], include: string): void;
+ compareMatched(match: string, exclude: string): void;
+ compareMatched(match: RegExp, exclude: RegExp): void;
+ /**
+ * Explicitly define what files you want to compare
+ */
+ compareExplicit(list: string[]): void;
+ /**
+ * Compare image diffs generated in this test run only
+ */
+ compareSession(list?: any[]): void;
+ compareFiles(baseFile: string, diffFiles: string): PhantomCSSTest;
+ waitForTests(tests: PhantomCSSTest[]): void;
+ done(): void;
+ /**
+ * Turn off CSS transitions and jQuery animations
+ */
+ turnOffAnimations(): void;
+ getExitStatus(): number;
+ /**
+ * Get a list of image diffs generated in this test run
+ */
+ getCreatedDiffFiles(): Array;
+ }
-interface PhantomCSSOptions{
+ interface PhantomCSSTest {
+ filename?: string;
+ error?: boolean;
+ fail?: boolean;
+ success?: boolean;
+ failFile?: string;
+ mismatch?: any;
+ }
+
+ interface PhantomCSSOptions {
/**
Rebase is useful when you want to create new baseline
images without manually deleting the files
casperjs demo/test.js --rebase
*/
- rebase?: any;
+ rebase?: any;
/**
A reference to a particular Casper instance. Required for SlimerJS.
- */
- casper?: Casper;
+ */
+ casper?: Casper;
/**
libraryRoot is relative to this file and must point to your phantomcss folder (not lib or node_modules). If you are using NPM, this will be './node_modules/phantomcss'.
*/
- libraryRoot?: string;
-
- screenshotRoot?:string;
+ libraryRoot?: string;
+
+ screenshotRoot?: string;
/**
By default, failure images are put in the './failures' folder.
If failedComparisonsRoot is set to false a separate folder will
not be created but failure images can still be found alongside
the original and new images.
*/
- failedComparisonsRoot?:string;
+ failedComparisonsRoot?: string;
/**
You might want to keep master/baseline images in a completely
@@ -94,7 +93,7 @@ interface PhantomCSSOptions{
with version control systems. By default this resolves to the
screenshotRoot folder.
*/
- comparisonResultRoot?: string;
+ comparisonResultRoot?: string;
/**
Don't add count number to images. If set to false (default), a filename is
@@ -106,40 +105,40 @@ interface PhantomCSSOptions{
Remove results directory tree after run. Use in conjunction
with failedComparisonsRoot to see failed comparisons.
*/
- cleanupComparisonImages?: boolean;
+ cleanupComparisonImages?: boolean;
/**
* Don't add label to generated failure image
*/
- addLabelToFailedImage?:boolean;
+ addLabelToFailedImage?: boolean;
/**
* Change the output screenshot filenames for your specific
* integration
*/
- fileNameGetter?: (rootPath:string, fileName?:string) => string;
+ fileNameGetter?: (rootPath: string, fileName?: string) => string;
/**
Mismatch tolerance defaults to 0.05%. Increasing this value
will decrease test coverage
*/
- mismatchTolerance?: number;
-
- onPass?: (test:PhantomCSSTest) => void;
- onFail?: (test:PhantomCSSTest) => void;
- onTimeout?: (test:PhantomCSSTest) => void;
- onComplete?:( tests:PhantomCSSTest[], noOfFails:number, noOfErrors:number ) => void;
+ mismatchTolerance?: number;
+
+ onPass?: (test: PhantomCSSTest) => void;
+ onFail?: (test: PhantomCSSTest) => void;
+ onTimeout?: (test: PhantomCSSTest) => void;
+ onComplete?: (tests: PhantomCSSTest[], noOfFails: number, noOfErrors: number) => void;
/**
Called when creating new baseline images
*/
- onNewImage?: (test:PhantomCSSTest) => void;
+ onNewImage?: (test: PhantomCSSTest) => void;
- /**
- Prefix the screenshot number to the filename, instead of suffixing it
- */
- prefixCount?: boolean;
-
- hideElements?: string;
- outputSettings?: Resemble.OutputSettings;
-}
+ /**
+ Prefix the screenshot number to the filename, instead of suffixing it
+ */
+ prefixCount?: boolean;
-declare var phantomcss:PhantomCSS;
\ No newline at end of file
+ hideElements?: string;
+ outputSettings?: Resemble.OutputSettings;
+ }
+
+}
\ No newline at end of file