(#49) waitFor implementation

Author: s1hofmann

lib/screen.class.e2e.spec.ts

@@ -87,4 +87,25 @@ describe("Screen.", () => {
       });
     });
   });
+
+  it("should run without throwing", async () => {
+    // GIVEN
+    const timeout = 5000;
+    const visionAdapter = new VisionAdapter();
+    const SUT = new Screen(visionAdapter);
+    SUT.config.resourceDirectory = "./e2e/assets";
+
+    // WHEN
+    const start = Date.now();
+    try {
+      await SUT.waitFor("calculator.png", timeout);
+    } catch (e) {
+      // THEN
+      expect(e).toBe(`Action timed out after ${timeout} ms`);
+    }
+    const end = Date.now();
+
+    // THEN
+    expect(end - start).toBeGreaterThanOrEqual(timeout);
+  });
 });

lib/screen.class.ts

@@ -6,6 +6,7 @@ import { generateOutputPath } from "./generate-output-path.function";
 import { LocationParameters } from "./locationparameters.class";
 import { MatchRequest } from "./match-request.class";
 import { Region } from "./region.class";
+import { timeout } from "./util/poll-action.function";
 
 export class Screen {
   public config = {
@@ -64,6 +65,14 @@ export class Screen {
     });
   }
 
+  public async waitFor(
+    pathToNeedle: string,
+    timeoutMs: number = 5000,
+    params?: LocationParameters,
+  ): Promise<Region> {
+    return timeout(500, timeoutMs, () => this.find(pathToNeedle, params));
+  }
+
   public async capture(
     fileName: string,
     fileFormat: FileType = FileType.PNG,