Querylight TS Demo

simpleTextSearch

Runs the default simple-text-search strategy against a bundle created by createSimpleTextSearchIndex.

Back to docs search

Reference Entry

simpleTextSearch

API Reference · foundation · order 129

Runs the default simple-text-search strategy against a bundle created by createSimpleTextSearchIndex.

Relevant APIs

simpleTextSearch SimpleTextSearchIndex SimpleTextSearchRequest Hits

Tags

api-reference functions

simpleTextSearch

Runs the default simple-text-search strategy against a bundle created by createSimpleTextSearchIndex.

Declaration

function simpleTextSearch<T extends Record<string, unknown>>(index: SimpleTextSearchIndex<T>, __namedParameters: SimpleTextSearchRequest): Promise<Hits>

Signatures

```ts function simpleTextSearch>(index: SimpleTextSearchIndex, __namedParameters: SimpleTextSearchRequest): Promise ``` Runs the default simple-text-search strategy against a bundle created by [createSimpleTextSearchIndex](/docs/api/create-simple-text-search-index/).

Parameters

- `index: SimpleTextSearchIndex` - `__namedParameters: SimpleTextSearchRequest`