(#500) Provide types to now generic MatchResult

Author: s1hofmann

lib/provider/image-finder.interface.ts

@@ -1,6 +1,7 @@
 import { MatchRequest } from "../match-request.class";
 import { MatchResult } from "../match-result.class";
 import { Image } from "../image.class";
+import { Region } from "../region.class";
 
 /**
  * An ImageFinder should provide an abstraction layer to perform image matching
@@ -18,17 +19,17 @@ export interface ImageFinderInterface {
    */
   findMatch<PROVIDER_DATA_TYPE>(
     matchRequest: MatchRequest<Image, PROVIDER_DATA_TYPE>
-  ): Promise<MatchResult>;
+  ): Promise<MatchResult<Region>>;
 
   /**
    * findMatches should provide an abstraction to search for an image needle
    * in another image haystack
    *
-   * @param {MatchRequest} matchRequest A matchrequest containing needed matching data
+   * @param {MatchRequest} matchRequest A match request containing needed matching data
    * @returns {Promise<MatchResult[]>} A list of {@link MatchResult}s holding the match probability and location
    * @memberof ImageFinderInterface
    */
   findMatches<PROVIDER_DATA_TYPE>(
     matchRequest: MatchRequest<Image, PROVIDER_DATA_TYPE>
-  ): Promise<MatchResult[]>;
+  ): Promise<MatchResult<Region>[]>;
 }

lib/provider/text-finder.interface.ts

@@ -1,6 +1,7 @@
 import { MatchRequest } from "../match-request.class";
 import { MatchResult } from "../match-result.class";
 import { TextQuery } from "../query.class";
+import { Region } from "../region.class";
 
 /**
  * A TextFinder should provide an abstraction layer to perform text searches
@@ -18,7 +19,7 @@ export interface TextFinderInterface {
    */
   findMatch<PROVIDER_DATA_TYPE>(
     matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
-  ): Promise<MatchResult>;
+  ): Promise<MatchResult<Region>>;
 
   /**
    * findMatches should provide an abstraction to search for an image needle
@@ -30,5 +31,5 @@ export interface TextFinderInterface {
    */
   findMatches<PROVIDER_DATA_TYPE>(
     matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
-  ): Promise<MatchResult[]>;
+  ): Promise<MatchResult<Region>[]>;
 }