Interface TextFinderInterface

A TextFinder should provide an abstraction layer to perform text searches

TextFinderInterface

interface TextFinderInterface {
findMatch<PROVIDER_DATA_TYPE>(matchRequest): Promise<MatchResult<Region>>;
findMatches<PROVIDER_DATA_TYPE>(matchRequest): Promise<MatchResult<Region>[]>;
}

Index

Methods

findMatch findMatches

Methods

findMatch

findMatch<PROVIDER_DATA_TYPE>(matchRequest): Promise<MatchResult<Region>>
findMatch should provide an abstraction to search for an image needle in another image haystack
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
  A MatchRequest containing needed matching data
Returns Promise<MatchResult<Region>>
A MatchResult holding the match probability and location

Memberof
TextFinderInterface
- Defined in provider-interfaces/lib/text-finder.interface.ts:17

findMatches

findMatches<PROVIDER_DATA_TYPE>(matchRequest): Promise<MatchResult<Region>[]>
findMatches should provide an abstraction to search for an image needle in another image haystack
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
  A MatchRequest containing needed matching data
Returns Promise<MatchResult<Region>[]>
A list of MatchResults holding the match probability and location

Memberof
TextFinderInterface
- Defined in provider-interfaces/lib/text-finder.interface.ts:29

Generated using TypeDoc