Class OptionalSearchParameters<PROVIDER_DATA_TYPE>

OptionalSearchParameters serves as a data class holding optional parameters for search purposes

Type Parameters

PROVIDER_DATA_TYPE

Index

Constructors

Properties

abort? confidence? providerData? searchRegion?

Constructors

constructor

new OptionalSearchParameters<PROVIDER_DATA_TYPE>(searchRegion?, confidence?, abort?, providerData?): OptionalSearchParameters<PROVIDER_DATA_TYPE>
OptionalSearchParameters class constructor
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- Optional searchRegion: Region | Promise<Region>
  Optional Region to limit the search space to
- Optional confidence: number
  Optional confidence value to configure image or text match confidence
- Optional abort: AbortSignal
  An AbortSignal to cancel an ongoing call to waitFor
- Optional providerData: PROVIDER_DATA_TYPE
  Optional data that gets passed onto the provider implementation
Returns OptionalSearchParameters<PROVIDER_DATA_TYPE>
- Defined in shared/lib/objects/optionalsearchparameters.class.ts:15

Properties

`Optional` abort

abort?: AbortSignal

An AbortSignal to cancel an ongoing call to waitFor

`Optional` confidence

confidence?: number

Optional confidence value to configure image or text match confidence

`Optional` providerData

providerData?: PROVIDER_DATA_TYPE

Optional data that gets passed onto the provider implementation

`Optional` searchRegion

searchRegion?: Region | Promise<Region>

Optional Region to limit the search space to

Generated using TypeDoc