pagination.ts

Source : sdks/typescript/packages/sdk/src/pagination.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Interface Page

Une page d'une liste : les éléments et le curseur de la page suivante.

Champs :

Nom	Type	Requis	Description
items	T[]	oui	Éléments de la page.
next_cursor	string | null	oui	Curseur de la page suivante, null sur la dernière page.

Interface ListParams

Requête d'une liste : limit, cursor et n'importe quel filtre.

Champs :

Nom	Type	Requis	Description
limit	number	non	Nombre maximal d'éléments dans une page. Le serveur plafonne la valeur ; lisez la page suivante avec cursor.
cursor	string	non	Curseur opaque renvoyé dans next_cursor par la page précédente. Omettez-le pour lire la première page.

Fonctions

collect

async collect(iter: AsyncIterable<T>, max = Infinity): Promise<T[]>

Rassemble tous les éléments d'une liste paginée (à utiliser avec prudence sur les grandes collections).

Nom	Type	Défaut	Requis	Description
iter	AsyncIterable<T>		oui	Itérable asynchrone à lire, par exemple le résultat de paginate.
max		Infinity	non	Nombre maximal d'éléments à rassembler (sans limite par défaut).

Retour : Promise<T[]>. Tableau des éléments lus.