OffsetParams

OffsetParams = object

Defined in: packages/db/src/types.ts:247

Parsed offset-based pagination parameters from a request URL.

Produced by parseOffsetParams. Pass to db.query(table).paginate() for traditional page-number-based pagination with total counts.

Example

const params = parseOffsetParams(request, { defaultLimit: 20 });
const page = await db.query(posts).paginate(params).run({});

Properties

limit

limit: number

Defined in: packages/db/src/types.ts:253

Maximum items per page (clamped between 1 and maxLimit).

---

page

page: number

Defined in: packages/db/src/types.ts:251

The 1-based page number.

---

type

type: "offset"

Defined in: packages/db/src/types.ts:249

Discriminant for offset-based pagination. Always "offset".