Paginador

Paginador de X API con amplia funcionalidad

Esta clase ofrece un soporte de paginación completo para la X API, que incluye:

• Iteración automática con bucles for await...of
• Control manual de páginas con fetchNext() y fetchPrevious()
• Acceso a metadatos para tokens y recuentos de paginación
• Manejo de errores y detección de límites de uso
• Soporte para paginación tanto hacia adelante como hacia atrás

Ejemplo

// Automatic iteration
const followers = await client.users.getFollowers('783214');
for await (const follower of followers) {
  console.log(follower.username);
}

// Manual control
const followers = await client.users.getFollowers('783214');
await followers.fetchNext();
console.log(followers.items.length); // Number of followers
console.log(followers.meta.nextToken); // Token de página siguiente

// Check status
if (!followers.done) {
  await followers.fetchNext();
}

​

Parámetros de type

Name	Description
T	El type de los elementos paginados

​

Jerarquía

• Paginator

  ↳ PostPaginator

  ↳ UserPaginator

  ↳ EventPaginator

​

Implementa

• AsyncIterable<T>

​

Constructores

​

constructor

• new Paginator<T>(fetchPage): Paginator<T>

Crea una nueva instancia de Paginator

​

Parámetros de tipo

Nombre
T

​

Parámetros

Nombre	Tipo	Descripción
fetchPage	(token?: string) => Promise<PaginatedResponse<T>>	Función que obtiene una página de datos a partir de un token de paginación

​

Devuelve

Paginator<T>

​

Definido en

paginator.ts:90

​

Métodos de acceso

​

items

• get items(): T[]

Devuelve todos los elementos obtenidos

​

Devuelve

T[]

​

Definido en

paginator.ts:97

---

​

meta

• get meta(): any

Obtiene los metadatos de paginación actuales

​

Devuelve

any

​

Definido en

paginator.ts:104

---

​

includes

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

Obtiene los datos actuales de includes

​

Devuelve

undefined | Record<string, any>

​

Definido en

paginator.ts:111

---

​

errors

• get errors(): undefined | any[]

Obtiene los errores actuales

​

Devuelve

undefined | any[]

​

Definido en

paginator.ts:118

---

​

done

• get done(): boolean

Comprueba si la paginación ha finalizado

​

Devuelve

boolean

​

Definido en

paginator.ts:125

---

​

rateLimited

• get rateLimited(): boolean

Comprueba si se alcanzó el límite de solicitudes

​

Devuelve

boolean

​

Definido en

paginator.ts:132

​

Métodos

​

fetchNext

▸ fetchNext(): Promise<void>

Obtiene la página siguiente y añade elementos a la instancia actual

Este método obtiene la siguiente página de datos y agrega los elementos a la instancia actual del paginador. Actualiza el estado de la paginación y los metadatos.

​

Devuelve

Promise<void>

Ejemplo

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Obtener la primera página
console.log(followers.items.length); // Cantidad de seguidores

if (!followers.done) {
  await followers.fetchNext(); // Obtener la segunda página
  console.log(followers.items.length); // Total de seguidores entre páginas
}

Throws

Cuando falla la solicitud a la API

​

Definido en

paginator.ts:156

---

​

next

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

Obtiene la página siguiente como una nueva instancia

Este método crea una nueva instancia de Paginator que comienza en la siguiente página, sin afectar el estado del Paginator actual.

​

Devuelve

Promise<Paginator<T>>

Nueva instancia de Paginator para la siguiente página

Ejemplo

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Obtener la primera página

if (!followers.done) {
  const nextPage = await followers.next(); // Obtener la siguiente página como una nueva instancia
  console.log(followers.items.length); // Aún la primera página
  console.log(nextPage.items.length); // La segunda página
}

​

Definido en

paginator.ts:211

---

​

fetchPrevious

▸ fetchPrevious(): Promise<void>

Recupera la página anterior (si se admite)

​

Devuelve

Promise<void>

​

Definido en

paginator.ts:225

---

​

previous

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

Obtiene la página anterior como una nueva instancia

​

Devuelve

Promise<Paginator<T>>

​

Definido en

paginator.ts:260

---

​

fetchLast

▸ fetchLast(count): Promise<void>

Obtiene hasta el número especificado de elementos adicionales

​

Parámetros

Nombre	type
count	number

​

Devuelve

Promise<void>

​

Definido en

paginator.ts:274

---

​

reset

▸ reset(): void

Reinicia el paginador a su estado inicial

​

Devuelve

void

​

Definido en

paginator.ts:288

---

​

[iterator]

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

Iterador de todos los elementos obtenidos

​

Devuelve

Iterator<T, any, undefined>

​

Definido en

paginator.ts:303

---

​

[asyncIterator]

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

Iterador asíncrono que recupera páginas automáticamente

​

Devuelve

AsyncIterator<T, any, undefined>

​

Implementación de

AsyncIterable.[asyncIterator]

​

Definido en

paginator.ts:312