UserPaginator

Paginador de usuarios

​

Jerarquía

• Paginator<any>

  ↳ UserPaginator

​

Constructores

​

constructor

• new UserPaginator(fetchPage): UserPaginator

Crea una nueva instancia de un paginador

​

Parámetros

Nombre	Tipo	Descripción
fetchPage	(token?: string) => Promise<PaginatedResponse<any>>	Función que recupera una página de datos dado un token de paginación

​

Devuelve

UserPaginator

​

Heredado de

Paginator.constructor

​

Definido en

paginator.ts:87

​

Accesores de acceso

​

elementos

• get elementos(): T[]

Obtener todos los elementos obtenidos

​

Devuelve

T[]

​

Heredado de

Paginator.items

​

Definido en

paginator.ts:94

---

​

meta

• get meta(): any

Obtener los metadatos actuales de paginación

​

Devoluciones

any

​

Heredado de

Paginator.meta

​

Definido en

paginator.ts:101

---

​

includes

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

Obtener los datos actuales de includes

​

Devuelve

undefined | Record<string, any>

​

Heredado de

Paginator.includes

​

Definido en

paginator.ts:108

---

​

errors

• get errors(): undefined | any[]

Obtener los errores actuales

​

Valor de retorno

undefined | any[]

​

Herdado de

Paginator.errors

​

Definido en

paginator.ts:115

---

​

done

• get done(): boolean

Comprueba si la paginación ha finalizado

​

Devuelve

boolean

​

Heredado de

Paginator.done

​

Definido en

paginator.ts:122

---

​

rateLimited

• get rateLimited(): boolean

Comprueba si se alcanzó el límite de solicitudes

​

Devuelve

booleano

​

Heredado de

Paginator.rateLimited

​

Definido en

paginator.ts:129

---

​

users

• get usuarios(): any[]

​

Devuelve

any[]

​

Definido en

paginator.ts:348

​

Métodos

​

fetchNext

▸ fetchNext(): Promise<void>

Obtiene la página siguiente y agrega elementos a la instancia actual

Este método obtiene la siguiente página de data y añade los elementos a la instancia actual del paginador. Actualiza el estado de paginación y la meta.

​

Devuelve

Promise<void>

Ejemplo

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

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

Lanza

Cuando falla la solicitud a la API

​

Heredado de

Paginator.fetchNext

​

Definido en

paginator.ts:153

---

​

next

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

Obtener la página siguiente como una nueva instancia

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

​

Devuelve

Promise<Paginator<any>>

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 nueva instancia
  console.log(followers.items.length); // Aún la primera página
  console.log(nextPage.items.length); // Segunda página
}

​

Heredado de

Paginator.next

​

Definido en

paginator.ts:208

---

​

fetchPrevious

▸ fetchPrevious(): Promise<void>

Obtiene la página anterior (si es compatible)

​

Devuelve

Promise<void>

​

Heredado de

Paginator.fetchPrevious

​

Definido en

paginator.ts:222

---

​

previous

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

Obtiene la página anterior como una nueva instancia

​

Devuelve

Promise<Paginator<any>>

​

Heredado de

Paginator.previous

​

Definido en

paginator.ts:257

---

​

fetchLast

▸ fetchLast(count): Promise<void>

Recupera hasta la cantidad especificada de elementos adicionales

​

Parámetros

Nombre	Tipo
count	number

​

Valor de retorno

Promise<void>

​

Heredado de

Paginator.fetchLast

​

Definido en

paginator.ts:271

---

​

reset

▸ reset(): void

Restablece el paginador a su estado inicial

​

Devuelve

void

​

Heredado de

Paginator.reset

​

Definido en

paginator.ts:285

---

​

[iterator]

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

Iterador de todos los elementos recuperados

​

Devuelve

Iterator<any, any, undefined>

​

Heredado de

Paginator.[iterator]

​

Definido en

paginator.ts:300

---

​

[asyncIterator]

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

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

​

Devuelve

AsyncIterator<any, any, undefined>

​

Heredado de

Paginator.[asyncIterator]

​

Definido en

paginator.ts:309