UserPaginator

Paginador de usuarios

Jerarquía

Paginator<any> ↳ UserPaginator

Constructores

constructor

• new UserPaginator(fetchPage): UserPaginator Crea una nueva instancia del paginador

Parámetros

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

Accesores

items

• get items(): T[] Devuelve todos los elementos obtenidos

Devuelve

T[]

Heredado de

Paginator.items

Definido en

paginator.ts:97

includes

• get includes(): undefined | Record<string, any> Obtiene los datos actuales de includes.

Devuelve

undefined | Record<string, any>

Heredado de

Paginator.includes

Definido en

paginator.ts:111

errors

• get errors(): undefined | any[] Obtiene los valores actuales de errors

Devuelve

undefined | any[]

Heredado de

Paginator.errors

Definido en

paginator.ts:118

done

• get done(): boolean Comprueba si la paginación ha finalizado

Devuelve

boolean

Heredado de

Paginator.done

Definido en

paginator.ts:125

rateLimited

• get rateLimited(): boolean Comprueba si se alcanzó el límite de tasa

Devuelve

boolean

Heredado de

Paginator.rateLimited

Definido en

paginator.ts:132

usuarios

• get users(): any[]

Devuelve

any[]

Definido en

paginator.ts:351

Métodos

fetchNext

▸ fetchNext(): Promise<void> Obtiene la siguiente página y agrega 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

Heredado de

Paginator.fetchNext

Definido en

paginator.ts:156

▸ next(): Promise<Paginator<any>> Obtiene la página siguiente como una nueva instancia Este método crea una nueva instancia de Paginator que comienza desde la página siguiente, sin afectar el estado del Paginator 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 una nueva instancia
  console.log(followers.items.length); // Aún la primera página
  console.log(nextPage.items.length); // La segunda página
}