ListQuery

ListQuery = object

Defined in: packages/schema/src/model.ts:161

One page of a list, as the query package reads it from the database.

Properties

columns?

optional columns?: string[]

Defined in: packages/schema/src/model.ts:167

The fields it reads, by name; every field when omitted.

---

cursor?

optional cursor?: string

Defined in: packages/schema/src/model.ts:169

Where the page starts: a cursor from a previous page.

---

direction?

optional direction?: "after" | "before"

Defined in: packages/schema/src/model.ts:171

Whether the page comes after the cursor (the default) or before it.

---

filter?

optional filter?: CheckedFilter

Defined in: packages/schema/src/model.ts:163

The rows it keeps, already checked against the resource.

---

limit

limit: number

Defined in: packages/schema/src/model.ts:173

The most rows the page holds.

---

sort?

optional sort?: SortSpec

Defined in: packages/schema/src/model.ts:165

The order; the primary key decides ties.