(#329) Make Screen#find only accept Image or Promise<Image> parameter type

Author: s1hofmann

lib/assert.class.spec.ts

@@ -2,6 +2,7 @@ import {AssertClass} from "./assert.class";
 import {Region} from "./region.class";
 import {ScreenClass} from "./screen.class";
 import providerRegistry from "./provider/provider-registry.class";
+import {imageResource} from "../index";
 
 jest.mock('jimp', () => {
 });
@@ -18,7 +19,7 @@ describe("Assert", () => {
         // WHEN
 
         // THEN
-        await expect(SUT.isVisible(needle)).resolves.not.toThrowError();
+        await expect(SUT.isVisible(imageResource(needle))).resolves.not.toThrowError();
     });
 
     it("isVisible should throw if a match is found.", async () => {
@@ -31,7 +32,7 @@ describe("Assert", () => {
         // WHEN
 
         // THEN
-        await expect(SUT.isVisible(needle)).rejects.toThrowError(`Element '${needle}' not found`);
+        await expect(SUT.isVisible(imageResource(needle))).rejects.toThrowError(`Element '${needle}' not found`);
     });
 
     it("isVisible should throw if a match is found.", async () => {
@@ -46,7 +47,7 @@ describe("Assert", () => {
 
         // THEN
         await expect(SUT
-            .isVisible(needle, searchRegion))
+            .isVisible(imageResource(needle), searchRegion))
             .rejects.toThrowError(`Element '${needle}' not found in region ${searchRegion.toString()}`
             );
     });
@@ -61,7 +62,7 @@ describe("Assert", () => {
         // WHEN
 
         // THEN
-        await expect(SUT.notVisible(needle)).rejects.toThrowError(`'${needle}' is visible`);
+        await expect(SUT.notVisible(imageResource(needle))).rejects.toThrowError(`'${needle}' is visible`);
     });
 
     it("isVisible should throw if a match is found.", async () => {
@@ -74,6 +75,6 @@ describe("Assert", () => {
         // WHEN
 
         // THEN
-        await expect(SUT.notVisible(needle)).resolves.not.toThrowError();
+        await expect(SUT.notVisible(imageResource(needle))).resolves.not.toThrowError();
     });
 });

lib/region.class.ts

@@ -29,7 +29,6 @@ export class Region {
   }
 
   public toString() {
-    return `(${this.left}, ${this.top}, ${this.left + this.width}, ${this.top +
-      this.height})`;
+    return `(${this.left}, ${this.top}, ${this.width}, ${this.height})`;
   }
 }

lib/screen.class.ts

@@ -8,7 +8,6 @@ import {Region} from "./region.class";
 import {timeout} from "./util/timeout.function";
 import {Image} from "./image.class";
 import {ProviderRegistry} from "./provider/provider-registry.class";
-import {loadImageResource} from "./imageResources.function";
 import {FirstArgumentType} from "./typings";
 import {Point} from "./point.class";
 
@@ -97,20 +96,15 @@ export class ScreenClass {
      * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
      */
     public async find(
-        templateImage: string | Image | Promise<Image>,
+        templateImage: Image | Promise<Image>,
         params?: LocationParameters,
     ): Promise<Region> {
         const minMatch = (params && params.confidence) || this.config.confidence;
         const screenSize = await this.providerRegistry.getScreen().screenSize();
         const searchRegion = (params && params.searchRegion) || screenSize;
         const searchMultipleScales = (params && params.searchMultipleScales)
 
-        let needle: Image;
-        if (typeof templateImage === "string") {
-            needle = await loadImageResource(this.providerRegistry, this.config.resourceDirectory, templateImage);
-        } else {
-            needle = await templateImage;
-        }
+        const needle = await templateImage;
 
         const screenImage = await this.providerRegistry.getScreen().grabScreenRegion(searchRegion);
 
@@ -154,20 +148,15 @@ export class ScreenClass {
      * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
      */
     public async findAll(
-        templateImage: string | Image | Promise<Image>,
+        templateImage: Image | Promise<Image>,
         params?: LocationParameters,
     ): Promise<Region[]> {
         const minMatch = (params && params.confidence) || this.config.confidence;
         const screenSize = await this.providerRegistry.getScreen().screenSize();
         const searchRegion = (params && params.searchRegion) || screenSize;
         const searchMultipleScales = (params && params.searchMultipleScales)
 
-        let needle: Image;
-        if (typeof templateImage === "string") {
-            needle = await loadImageResource(this.providerRegistry, this.config.resourceDirectory, templateImage);
-        } else {
-            needle = await templateImage;
-        }
+        const needle = await templateImage;
 
         const screenImage = await this.providerRegistry.getScreen().grabScreenRegion(searchRegion);