Skip to content

Meilisearch JS / index / DocumentsQuery

Type Alias: DocumentsQuery<T>

DocumentsQuery<T> = ResourceQuery & object

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

Type Declaration

fields?

optional fields?: Fields<T>

filter?

optional filter?: Filter

ids?

optional ids?: string[] | number[]

limit?

optional limit?: number

offset?

optional offset?: number

retrieveVectors?

optional retrieveVectors?: boolean

sort?

optional sort?: string[]

Array of strings containing the attributes to sort on. Each string should be in the format "attribute:direction" where direction is either "asc" or "desc". Example: ["price:asc", "rating:desc"]

Type Parameters

T

T = RecordAny