EventPaginator

Paginator d’événements (par exemple les événements de DM)

Hiérarchie

• Paginator<any>

  ↳ EventPaginator

Constructeurs

constructor

• new EventPaginator(fetchPage): EventPaginator

Crée une nouvelle instance d’EventPaginator

Paramètres

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

Retourne

EventPaginator

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

Retourne les métadonnées de pagination actuelles

Renvoie

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 includes

Valeur renvoyée

undefined | Record<string, any>

Hérité de

Paginator.includes

Défini dans

paginator.ts:111

---

errors

• get errors(): undefined | any[]

Récupérer les erreurs 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érifie si la limite de taux a été atteinte

Renvoie

boolean

Hérité de

Paginator.rateLimited

Défini dans

paginator.ts:132

---

events

• get events(): any[]

Renvoie

any[]

Défini dans

paginator.ts:362

Méthodes

fetchNext

▸ fetchNext(): Promise<void>

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

Cette méthode récupère la page suivante de données et ajoute les éléments à l’instance de paginateur en cours. 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

Quand la requête à l’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 forme de nouvelle instance

Cette méthode crée une nouvelle instance de paginator qui démarre à la page suivante, sans modifier 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éfinie dans

paginator.ts:211

---

fetchPrevious

▸ fetchPrevious(): Promise<void>

Récupère la page précédente (si disponible)

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 sous forme de 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 d’éléments supplémentaires spécifié

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 paginateur à son état initial

Retourne

void

Hérité de

Paginator.reset

Défini dans

paginator.ts:288

---

[iterator]

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

Itérateur pour parcourir tous les é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 automatiquement les pages

Retourne

AsyncIterator<any, any, undefined>

Hérité de

Paginator.[asyncIterator]

Défini dans

paginator.ts:312