interface

ListOptions

interface ListOptions<Where, Select, Populate, Locale extends string = string> { ... }

Typed filtering, projection, population, sorting, pagination, locale, and trash options.

Source packages/sdk/src/index.ts:33

pagenumber
The page value.
limitnumber
The limit value.
depthnumber
The depth value.
whereWhere
The where value.
selectSelect
The select value.
populatePopulate
The populate value.
sortreadonly string[]
The sort value.
trashboolean
The trash value.
locale[Locale] extends [never] ? never : "all" | Locale
Content locale. Use "all" to receive locale-keyed localized fields.
fallbackLocale[Locale] extends [never] ? never : false | Locale | readonly Locale[]
Explicit fallback chain, or false to require an exact locale value.
signalAbortSignal
The signal value.
headersHeadersInit | undefined
The headers value.
keepaliveboolean
The keepalive value.

Prefix a sort field with - for descending order. where, select, and populate are generated per collection.