Class OptionalSearchParameters<PROVIDER_DATA_TYPE>

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

Type Parameters

  • PROVIDER_DATA_TYPE

Hierarchy

  • OptionalSearchParameters

Constructors

  • OptionalSearchParameters class constructor

    Type Parameters

    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>

Properties

abort?: AbortSignal
confidence?: number
providerData?: PROVIDER_DATA_TYPE
searchRegion?: Region | Promise<Region>