Skip to content

Interface: UseSearchOptions

Options for useSearch.

optional debounceMs?: number

Debounce in ms before a keystroke triggers a request. Defaults to 200.


optional index?: string

Which index to search (name or alias). Defaults to the plugin’s default index.


optional limit?: number

Max hits to request. Defaults to the plugin’s configured page size.


optional minLength?: number

Minimum query length before searching. Defaults to 1.


optional mode?: "hybrid" | "vector" | "keyword"

Match mode. Defaults to the plugin’s configured mode.


optional universal?: boolean

Search every configured index and merge results (universal search).