UserPaginator

Pagineur pour les utilisateurs

Hiérarchie

• Paginator<any>

  ↳ UserPaginator

Constructeurs

constructor

• new UserPaginator(fetchPage): UserPaginator

Crée une nouvelle instance de UserPaginator

Paramètres

Nom	Type	Description
fetchPage	(token?: string) => Promise<PaginatedResponse<any>>	Fonction qui récupère une page de données pour un jeton de pagination donné

Renvoie

UserPaginator

Hérité de

Paginator.constructor

Défini dans

paginator.ts:90

Accesseurs

items

• get items(): T[]

Renvoie tous les éléments récupérés

Renvoie

T[]

Hérité de

Paginator.items

Défini dans

paginator.ts:97

---

meta

• get meta(): any

Récupère les métadonnées de pagination actuelles

Retourne

any

Hérité de

Paginator.meta

Défini dans

paginator.ts:104

---

includes

• get includes(): undefined | Record<string, any>

Récupère les données actuelles de la section includes.

Retourne

undefined | Record<string, any>

Hérité de

Paginator.includes

Défini dans

paginator.ts:111

---

errors

• get errors(): undefined | any[]

Récupère les errors actuelles

Renvoie

undefined | any[]

Hérité de

Paginator.errors

Défini dans

paginator.ts:118

---

done

• get done(): boolean

Vérifie si la pagination est terminée.

Renvoie

boolean

Hérité de

Paginator.done

Défini dans

paginator.ts:125

---

rateLimited

• get rateLimited(): boolean

Vérifier si la limite de débit a été atteinte

Retourne

boolean

Hérité de

Paginator.rateLimited

Défini dans

paginator.ts:132

---

utilisateurs

• get users(): any[]

Renvoie

any[]

Défini dans

paginator.ts:351

Méthodes

fetchNext

▸ fetchNext(): Promise<void>

Récupère la page suivante et ajoute les éléments à l’instance actuelle

Cette méthode récupère la page suivante de données et ajoute les éléments à l’instance actuelle du paginateur. Elle met à jour l’état de la pagination et les métadonnées.

Renvoie

Promise<void>

Exemple

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Récupère la première page
console.log(followers.items.length); // Nombre d'abonnés

if (!followers.done) {
  await followers.fetchNext(); // Récupère la deuxième page
  console.log(followers.items.length); // Total des abonnés sur toutes les pages
}

Throws

Lorsque la requête d’API échoue

Hérité de

Paginator.fetchNext

Défini dans

paginator.ts:156

---

next

▸ next(): Promise<Paginator<any>>

Récupérer la page suivante sous la forme d’une nouvelle instance

Cette méthode crée une nouvelle instance de Paginator qui démarre à partir de la page suivante, sans affecter l’état du Paginator actuel.

Renvoie

Promise<Paginator<any>>

Nouvelle instance de Paginator pour la page suivante

Exemple

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Récupère la première page

if (!followers.done) {
  const nextPage = await followers.next(); // Obtient la page suivante en tant que nouvelle instance
  console.log(followers.items.length); // Toujours la première page
  console.log(nextPage.items.length); // Deuxième page
}

Hérité de

Paginator.next

Défini dans

paginator.ts:211

---

fetchPrevious

▸ fetchPrevious(): Promise<void>

Récupère la page précédente (si elle est prise en charge)

Renvoie

Promise<void>

Hérité de

Paginator.fetchPrevious

Défini dans

paginator.ts:225

---

previous

▸ previous(): Promise<Paginator<any>>

Récupère la page précédente en tant que nouvelle instance

Renvoie

Promise<Paginator<any>>

Hérité de

Paginator.previous

Défini dans

paginator.ts:260

---

fetchLast

▸ fetchLast(count): Promise<void>

Récupère jusqu’au nombre spécifié d’éléments supplémentaires

Paramètres

Nom	Type
count	number

Renvoie

Promise<void>

Hérité de

Paginator.fetchLast

Défini dans

paginator.ts:274

---

reset

▸ reset(): void

Réinitialise le paginator à son état initial.

Renvoie

void

Hérité de

Paginator.reset

Définie dans

paginator.ts:288

---

[iterator]

▸ [iterator](): Iterator<any, any, undefined>

Itérateur sur l’ensemble des éléments récupérés

Renvoie

Iterator<any, any, undefined>

Hérité de

Paginator.[iterator]

Défini dans

paginator.ts:303

---

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<any, any, undefined>

Itérateur asynchrone qui récupère les pages automatiquement

Retourne

AsyncIterator<any, any, undefined>

Hérité de

Paginator.[asyncIterator]

Définition dans

paginator.ts:312