@interopio/browser API Reference

Access via:io.search

Search API.

Properties (1)

Property Type Default Required Description
version⚓︎ string x

Search API version.

6 Methods

getDebounceMS()⚓︎

() => number

Retrieves the current debounce interval for search queries.

listProviders()⚓︎

() => Promise<ProviderData[]>

Retrieves a list of all available search providers.

listTypes()⚓︎

() => Promise<SearchType[]>

Retrieves a list of all available search types from all search providers.

query()⚓︎

(queryConfig: QueryConfig) => Promise<Query>

Creates a search query.

Parameters (1)

Name Type Required Description
queryConfig⚓︎ QueryConfig

Settings for creating a search query.

registerProvider()⚓︎

(config: ProviderRegistrationConfig) => Promise<Provider>

Registers a search provider.

Parameters (1)

Name Type Required Description
config⚓︎ ProviderRegistrationConfig

Settings for registering a search provider.

setDebounceMS()⚓︎

(milliseconds: number) => void

Sets the debounce interval for search queries.

Parameters (1)

Name Type Required Description
milliseconds⚓︎ number

Interval in milliseconds to use as debounce interval.