Paginação

list() responde com uma página. Page<T> é uma união do envelope por offset (total_count, next) com o envelope por cursor (has_more, next_cursor), e qual deles se recebe depende do parâmetro paginate do pedido. Restrinja com v2.isCursorPage / v2.isOffsetPage antes de ler um campo específico de um dos envelopes. Lê-lo sem restringir é um erro de compilação, já que pode não existir na outra metade da união:

import { v2 } from "@hoyasumii/plane";

const page = await client.v2.workspaces.projects.states.list("acme", "ENG");
if (v2.isOffsetPage(page)) {
  console.log(page.total_count); // só alcançável depois de restringir
} else if (v2.isCursorPage(page)) {
  console.log(page.next_cursor);
}

Toda a página tem data, as próprias linhas.

Os controlos de paginação

Os params de listagem aceitam per_page, mais offset (paginação por offset) ou paginate: "cursor" com o cursor da página anterior. count: false evita o cálculo de total_count numa página por offset.

const first = await client.v2.workspaces.projects.workItems.list("acme", "ENG", { per_page: 50, paginate: "cursor" });
if (v2.isCursorPage(first) && first.has_more) {
  await client.v2.workspaces.projects.workItems.list("acme", "ENG", {
    per_page: 50,
    paginate: "cursor",
    cursor: first.next_cursor ?? undefined,
  });
}

iterate

iterate percorre as páginas automaticamente e entrega linhas, pelo que não aceita os controlos que o próprio ciclo já define. As linhas de um recurso navegável continuam navegáveis:

for await (const item of client.v2.workspaces.projects.workItems.iterate("acme", "ENG", { per_page: 100 })) {
  console.log(item.name);
}