Skip to content

FindOptions

FindOptions<ARG_TYPES, FETCH> = { is: ArrayOrOnlyItem<ARG_TYPES>; } | { from: ArrayOrOnlyItem<ARG_TYPES>; } | { after: ArrayOrOnlyItem<ARG_TYPES>; } | { } & { to: ArrayOrOnlyItem<ARG_TYPES>; } | { before: ArrayOrOnlyItem<ARG_TYPES>; } | { } & object & FETCH extends undefined ? object : object

Defined in: .work/repos/edinburgh/src/indexes.ts:110

Range-query options accepted by find(), findBy(), batchProcess(), and batchProcessBy().

Supports exact-match lookups via is, inclusive bounds via from / to, exclusive bounds via after / before, and reverse scans.

For single-field indexes, values can be passed directly. For composite indexes, pass tuples or partial tuples for prefix matching. If an index field is a link(...), you may pass either the linked model instance or the linked model’s primary key. Composite linked primary keys are passed as tuples in that slot.

optional reverse?: boolean

ARG_TYPES extends readonly any[]

Tuple of index argument types.

FETCH extends "first" | "single" | undefined = undefined

Optional fetch mode used by overloads that return one row.