Meilisearch JavaScript

Appearance

Meilisearch JS / index / SearchResponse

Type Alias: SearchResponse<T, S> ​

SearchResponse<T, S> = object & undefined extends S ? Partial<FinitePagination & InfinitePagination> : true extends IsFinitePagination<NonNullable<S>> ? FinitePagination : InfinitePagination

Defined in: src/types/types.ts:405

Type Declaration ​

facetDistribution? ​

optional facetDistribution?: FacetDistribution

facetsByIndex? ​

optional facetsByIndex?: FacetsByIndex

facetStats? ​

optional facetStats?: FacetStats

hits ​

hits: Hits<T>

metadata? ​

optional metadata?: SearchMetadata

Experimental

Query and index metadata

Present when the request sends Meili-Include-Metadata: true.

See ​

https://www.meilisearch.com/docs/reference/api/search/search-with-post

performanceDetails? ​

optional performanceDetails?: RecordAny

processingTimeMs ​

processingTimeMs: number

query ​

query: string

queryVector? ​

optional queryVector?: number[]

Type Parameters ​

T ​

T = RecordAny

S ​

S extends SearchParams | undefined = undefined