Skip to content

basalt / search/src / SearchResult

Interface: SearchResult ​

Defined in: search/src/types.ts:51

Properties ​

hits ​

> hits: SearchHit[]

Defined in: search/src/types.ts:52


total ​

> total: number

Defined in: search/src/types.ts:54

Total matches (before limit/offset).


totalExact? ​

> optional totalExact?: boolean

Defined in: search/src/types.ts:62

Whether total is the whole truth.

Only set by an authorized search (options.authorize), where the count is of hits the caller may see and the scan may have stopped at its budget. false means "at least this many" — render it as such, or not at all.

Released under the MIT License.