# API

**Kind**: interface | **Module**: [Search](https://docs.interop.io/desktop/reference/javascript/search/index.md) | **Access**: `io.search`

**Source**: https://docs.interop.io/desktop/reference/javascript/search/api/index.html

Search API.

## Properties

- **`version`** (`string`, required)
  Search API version.

## Methods

### getDebounceMS

Retrieves the current debounce interval for search queries.

```ts
() => number
```

**Returns**: `number`

### listProviders

Retrieves a list of all available search providers.

```ts
() => Promise<ProviderData[]>
```

**Returns**: `Promise<ProviderData[]>`

### listTypes

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

```ts
() => Promise<SearchType[]>
```

**Returns**: `Promise<SearchType[]>`

### query

Creates a search query.

```ts
(queryConfig: QueryConfig) => Promise<Query>
```

**Parameters**

- **`queryConfig`** (`QueryConfig`, required)
  Settings for creating a search query.

**Returns**: `Promise<Query>`

### registerProvider

Registers a search provider.

```ts
(config: ProviderRegistrationConfig) => Promise<Provider>
```

**Parameters**

- **`config`** (`ProviderRegistrationConfig`, required)
  Settings for registering a search provider.

**Returns**: `Promise<Provider>`

### setDebounceMS

Sets the debounce interval for search queries.

```ts
(milliseconds: number) => void
```

**Parameters**

- **`milliseconds`** (`number`, required)
  Interval in milliseconds to use as debounce interval.

**Returns**: `void`

## Related types

- [Provider](https://docs.interop.io/desktop/reference/javascript/search/provider/index.md)
- [ProviderData](https://docs.interop.io/desktop/reference/javascript/search/providerdata/index.md)
- [ProviderRegistrationConfig](https://docs.interop.io/desktop/reference/javascript/search/providerregistrationconfig/index.md)
- [Query](https://docs.interop.io/desktop/reference/javascript/search/query/index.md)
- [QueryConfig](https://docs.interop.io/desktop/reference/javascript/search/queryconfig/index.md)
- [SearchType](https://docs.interop.io/desktop/reference/javascript/search/searchtype/index.md)