parseOffsetParams

parseOffsetParams(request, options?): OffsetParams

Defined in: packages/db/src/paginate.ts:80

Parses offset-based pagination parameters from a request URL’s search params.

Reads page and limit from the URL query string. Clamps limit between 1 and maxLimit, and ensures page is at least 1. Returns an OffsetParams object ready to pass to db.query(table).paginate().

Parameters

request

Request

The incoming HTTP request whose URL contains ?page=...&limit=....

options?

PaginationOptions

Optional defaults and limits for pagination.

Returns

OffsetParams

Parsed OffsetParams with type, page, and limit.

Example

import { parseOffsetParams } from "@cfast/db";

const params = parseOffsetParams(request, { defaultLimit: 20 });
const page = await db.query(posts).paginate(params).run({});
// page => { items: [...], total: 100, page: 1, totalPages: 5 }