Page
Importa desde tyrus:db los tipos usados en anotaciones. En particular, importa Page explícitamente siempre que una firma de función use el tipo de resultado paginado.
interface Page<T> {
readonly items: T[];
readonly total: u64;
readonly pageSize: u64;
readonly page?: u64;
readonly totalPages?: u64;
readonly nextCursor?: string;
readonly hasMore?: boolean;
}La paginación numerada devuelve items, total, pageSize, page y totalPages. La paginación por cursor devuelve items, total, pageSize y hasMore, además de nextCursor cuando hay otra página. Se omiten los campos del modo de paginación inactivo.
Los elementos y el total de la página se leen desde la misma instantánea de transacción en todos los backends relacionales, así que las escrituras concurrentes no hacen que el recuento y los elementos describan estados distintos de la base de datos. MongoDB usa el _id generado para mantener un orden estable; el recuento y la lectura de elementos son operaciones separadas, por lo que las escrituras concurrentes pueden afectar su consistencia. Su token de cursor es el ObjectId serializado de 24 caracteres del último elemento devuelto; pasa nextCursor sin modificar a after.
Ejemplo de paginación numerada
Pasa el número de página con paginate: true. La primera página es la página 1; usa el totalPages devuelto para saber si hay más páginas numeradas.
import { DbError, Page } from "tyrus:db";
import { User } from "./models/User";
async function listUsersPage(page: u64): Promise<Result<Page<User>, DbError>> {
const data = await User.findMany({}, { paginate: true, pageSize: 25, page }) onfail {
return Err(data);
};
return Ok(data);
}
// Example result for page 1:
// {
// items: [{ id: 1, name: "Ada" }, ...],
// total: 64,
// pageSize: 25,
// page: 1,
// totalPages: 3
// }Ejemplo de paginación por cursor
Omite after para obtener la primera página. Pasa el nextCursor devuelto sin modificar como after para obtener la página siguiente. El cursor es el valor serializado del @id de la última fila devuelta, no la cantidad de elementos ni el número de página. Para un @id entero, "25" significa continuar después de la fila cuyo id es 25; after: "10" empieza después del id 10, no en el décimo resultado. No calcules el cursor a partir de pageSize.
import { DbError, Page } from "tyrus:db";
import { User } from "./models/User";
async function listFirstUsersCursorPage(): Promise<Result<Page<User>, DbError>> {
const data = await User.findMany({}, { paginate: true, pageSize: 25, cursor: true }) onfail {
return Err(data);
};
return Ok(data);
}
// Example result when another page is available:
// {
// items: [{ id: 1, name: "Ada" }, ...],
// total: 64,
// pageSize: 25,
// hasMore: true,
// nextCursor: "25"
// }
async function listNextUsersCursorPage(after: string): Promise<Result<Page<User>, DbError>> {
const data = await User.findMany({}, { paginate: true, pageSize: 25, cursor: true, after }) onfail {
return Err(data);
};
return Ok(data);
}
// Example result for the next page:
// {
// items: [{ id: 26, name: "Grace" }, ...],
// total: 64,
// pageSize: 25,
// hasMore: true,
// nextCursor: "50"
// }
// On the final page, hasMore is false and nextCursor is omitted.