(#340) Refactor Image#data to a Buffer instead of any

Author: s1hofmann

lib/image.class.spec.ts

@@ -14,29 +14,29 @@ afterEach(() => {
 
 describe("Image class", () => {
     it("should return alphachannel = true for > 3 channels", () => {
-        const SUT = new Image(200, 200, 123, 4, "id");
+        const SUT = new Image(200, 200, Buffer.from([123]), 4, "id");
         expect(SUT.hasAlphaChannel).toBeTruthy();
     });
 
     it("should return alphachannel = false for <= 3 channels", () => {
-        const SUT = new Image(200, 200, 123, 3, "id");
+        const SUT = new Image(200, 200, Buffer.from([123]), 3, "id");
         expect(SUT.hasAlphaChannel).toBeFalsy();
     });
     it("should return alphachannel = false for <= 3 channels", () => {
-        const SUT = new Image(200, 200, 123, 2, "id");
+        const SUT = new Image(200, 200, Buffer.from([123]), 2, "id");
         expect(SUT.hasAlphaChannel).toBeFalsy();
     });
     it("should return alphachannel = false for <= 3 channels", () => {
-        const SUT = new Image(200, 200, 123, 1, "id");
+        const SUT = new Image(200, 200, Buffer.from([123]), 1, "id");
         expect(SUT.hasAlphaChannel).toBeFalsy();
     });
 
     it("should throw for <= 0 channels", () => {
-        expect(() => new Image(200, 200, 123, 0, "id")).toThrowError("Channel <= 0");
+        expect(() => new Image(200, 200, Buffer.from([123]), 0, "id")).toThrowError("Channel <= 0");
     });
 
     it("should have a default pixel density of 1.0", () => {
-        const SUT = new Image(200, 200, 123, 1, "id");
+        const SUT = new Image(200, 200, Buffer.from([123]), 1, "id");
         expect(SUT.pixelDensity).toEqual({scaleX: 1.0, scaleY: 1.0});
     });
 

lib/image.class.ts

@@ -18,7 +18,7 @@ export class Image {
     constructor(
         public readonly width: number,
         public readonly height: number,
-        public readonly data: any,
+        public readonly data: Buffer,
         public readonly channels: number,
         public readonly id: string,
         public readonly colorMode: ColorMode = ColorMode.BGR,

lib/match-request.class.spec.ts

@@ -9,14 +9,14 @@ describe("MatchRequest", () => {
             new Image(
                 100,
                 100,
-                new ArrayBuffer(0),
+                Buffer.from([]),
                 3,
                 "haystack_image"
             ),
             new Image(
                 100,
                 100,
-                new ArrayBuffer(0),
+                Buffer.from([]),
                 3,
                 "needle_image"
             ),

lib/screen.class.spec.ts

@@ -19,7 +19,7 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
     getScreen(): ScreenProviderInterface {
         return mockPartial<ScreenProviderInterface>({
             grabScreenRegion(): Promise<Image> {
-                return Promise.resolve(new Image(searchRegion.width, searchRegion.height, new ArrayBuffer(0), 3, "needle_image"));
+                return Promise.resolve(new Image(searchRegion.width, searchRegion.height, Buffer.from([]), 3, "needle_image"));
             },
             screenSize(): Promise<Region> {
                 return Promise.resolve(searchRegion);
@@ -614,7 +614,7 @@ describe("Screen.", () => {
     describe("capture", () => {
         it("should capture the whole screen and save image", async () => {
             // GIVEN
-            const screenshot = mockPartial<Image>({data: "pretty pretty image"});
+            const screenshot = mockPartial<Image>({data: Buffer.from([])});
             const grabScreenMock = jest.fn(() => Promise.resolve(screenshot));
             const saveImageMock = jest.fn();
             providerRegistryMock.getScreen = jest.fn(() => mockPartial<ScreenProviderInterface>({
@@ -641,7 +641,7 @@ describe("Screen.", () => {
     describe("captureRegion", () => {
         it("should capture the specified region of the screen and save image", async () => {
             // GIVEN
-            const screenshot = mockPartial<Image>({data: "pretty partial image"});
+            const screenshot = mockPartial<Image>({data: Buffer.from([])});
             const regionToCapture = mockPartial<Region>({top: 42, left: 9, height: 10, width: 3.14159265359})
             const grabScreenMock = jest.fn(() => Promise.resolve(screenshot));
             const saveImageMock = jest.fn();

lib/screen.colorAt.spec.ts

@@ -8,7 +8,7 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
     getScreen(): ScreenProviderInterface {
         return mockPartial<ScreenProviderInterface>({
             grabScreenRegion(): Promise<Image> {
-                return Promise.resolve(new Image(searchRegion.width, searchRegion.height, new ArrayBuffer(0), 3, "needle_image"));
+                return Promise.resolve(new Image(searchRegion.width, searchRegion.height, Buffer.from([]), 3, "needle_image"));
             },
             screenSize(): Promise<Region> {
                 return Promise.resolve(searchRegion);