interface

FindOptions

Projection, population, depth, and locale options for one document or global.

Properties

PropertyTypeDescription
draftDrafts extends true ? boolean : falseSelect the authorized working draft rather than the public published snapshot.
depthnumberThe depth value.
selectSelectThe select value.
populatePopulateThe populate value.
locale[Locale] extends [never] ? never : "all" | LocaleContent 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.
signalAbortSignalThe signal value.
headersHeadersInit | undefinedThe headers value.
keepalivebooleanThe keepalive value.

Full signature

interface FindOptions< Select, Populate, Locale extends string = string, Drafts extends boolean = boolean, > { ... }

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