interface FindOptions
Since 0.1.0

Options for IRepository.findAll.

Properties

readonly
optional
where: Record<string, unknown>

Filter conditions keyed by field name.

readonly
optional
filter: FilterExpression

Portable filter expression conjoined with where.

readonly
optional
orderBy: Record<string, OrderDirection>

Field-to-direction sort specification.

readonly
optional
limit: number

Maximum number of results to return.

readonly
optional
offset: number

Number of results to skip.

readonly
optional
select: readonly string[]

Select only specific fields (projection).

readonly
optional
cursor: string

A keyset cursor position, or undefined when the query starts at the first page. Carried alongside offset rather than replacing it: an offset says "skip this many from the start" and a cursor says "after this row", and the two are contradictory — a query carrying both is refused by name (UnsupportedQueryFeatureError).

Usage

import { type FindOptions } from "database-plugin/src/index.ts";