Page
Importe de tyrus:db os tipos usados em anotações. Em especial, importe Page explicitamente sempre que uma assinatura de função usar o 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;
}A paginação numerada retorna items, total, pageSize, page e totalPages. A paginação por cursor retorna items, total, pageSize e hasMore, além de nextCursor quando existe outra página. Os campos do modo de paginação inativo são omitidos.
Os itens e o total da página são lidos do mesmo snapshot de transação em todos os backends relacionais, então gravações concorrentes não fazem a contagem e os itens descreverem estados diferentes do banco. O MongoDB usa o _id gerado para manter a ordenação estável; a contagem e a leitura dos itens são operações separadas, então gravações concorrentes podem afetar a consistência entre elas. Seu token de cursor é o ObjectId serializado de 24 caracteres do último item retornado; passe nextCursor sem alterações para after.
Exemplo de paginação numerada
Passe o número da página com paginate: true. A primeira página é a página 1; use o totalPages retornado para saber se há outras 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
// }Exemplo de paginação por cursor
Omita after para buscar a primeira página. Passe o nextCursor retornado sem alterações como after para buscar a próxima página. O cursor é o valor serializado do @id da última linha retornada, não a quantidade de itens nem o número da página. Para um @id inteiro, "25" significa continuar após a linha cujo id é 25; after: "10" começa após o id 10, não no décimo resultado. Não calcule o cursor usando 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.