Skip to content

parseCursorParams

parseCursorParams(request, options?): CursorParams

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

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

Reads cursor and limit from the URL query string. Clamps limit between 1 and maxLimit. Returns a CursorParams object ready to pass to db.query(table).paginate().

Request

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

PaginationOptions

Optional defaults and limits for pagination.

CursorParams

Parsed CursorParams with type, cursor, and limit.

import { parseCursorParams } from "@cfast/db";
const params = parseCursorParams(request, { defaultLimit: 20, maxLimit: 100 });
const page = await db.query(posts).paginate(params).run({});
// page => { items: [...], nextCursor: "..." | null }