Meilisearch JS / index / SearchParams

Type Alias: SearchParams

SearchParams = Query & Pagination & Highlight & Crop & object

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

Type Declaration

attributesToRetrieve?

optional attributesToRetrieve?: string[]

attributesToSearchOn?

optional attributesToSearchOn?: string[] | null

distinct?

optional distinct?: string

facetName?

optional facetName?: string

facetQuery?

optional facetQuery?: string

facets?

optional facets?: string[]

filter?

optional filter?: Filter

hitsPerPage?

optional hitsPerPage?: number

hybrid?

optional hybrid?: HybridSearch

locales?

optional locales?: Locale[]

matchingStrategy?

optional matchingStrategy?: MatchingStrategies

media?

optional media?: MediaPayload

page?

optional page?: number

personalize?

optional personalize?: Personalize

Personalize search results for a given user context.

Experimental; requires Meilisearch v1.47 or later with the personalization feature enabled.

rankingScoreThreshold?

optional rankingScoreThreshold?: number

retrieveVectors?

optional retrieveVectors?: boolean

showMatchesPosition?

optional showMatchesPosition?: boolean

showPerformanceDetails?

optional showPerformanceDetails?: boolean

showRankingScore?

optional showRankingScore?: boolean

showRankingScoreDetails?

optional showRankingScoreDetails?: boolean

sort?

optional sort?: string[]

vector?

optional vector?: number[] | null