> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# UserPaginator

Paginador de usuarios

<div id="hierarchy">
  ## Jerarquía
</div>

* [`Paginator`](/es/xdks/typescript/reference/classes/Paginator)\<`any`>

  ↳ **`UserPaginator`**

<div id="constructors">
  ## Constructores
</div>

<div id="constructor">
  ### constructor
</div>

• **new UserPaginator**(`fetchPage`): [`UserPaginator`](/es/xdks/typescript/reference/classes/UserPaginator)

Crea una nueva instancia del paginador

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Type                                                                                                                          | Descripción                                                                 |
| :---------- | :---------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- |
| `fetchPage` | (`token?`: `string`) => `Promise`\<[`PaginatedResponse`](/es/xdks/typescript/reference/interfaces/PaginatedResponse)\<`any`>> | Función que recupera una página de datos a partir de un token de paginación |

<div id="returns">
  #### Devuelve
</div>

[`UserPaginator`](/es/xdks/typescript/reference/classes/UserPaginator)

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[constructor](/es/xdks/typescript/reference/classes/Paginator#constructor)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:90](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L90)

<div id="accessors">
  ## Accesores
</div>

<div id="items">
  ### items
</div>

• `get` **items**(): `T`\[]

Devuelve todos los elementos obtenidos

<div id="returns">
  #### Devuelve
</div>

`T`\[]

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.items

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:97](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L97)

***

<div id="meta">
  ### meta
</div>

• `get` **meta**(): `any`

Obtiene los metadatos de paginación actuales.

<div id="returns">
  #### Devuelve
</div>

`any`

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.meta

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:104](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L104)

***

<div id="includes">
  ### includes
</div>

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

Obtiene los datos actuales de includes.

<div id="returns">
  #### Devuelve
</div>

`undefined` | `Record`\<`string`, `any`>

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.includes

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:111](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L111)

***

<div id="errors">
  ### errors
</div>

• `get` **errors**(): `undefined` | `any`\[]

Obtiene los valores actuales de errors

<div id="returns">
  #### Devuelve
</div>

`undefined` | `any`\[]

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.errors

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:118](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L118)

***

<div id="done">
  ### done
</div>

• `get` **done**(): `boolean`

Comprueba si la paginación ha finalizado

<div id="returns">
  #### Devuelve
</div>

`boolean`

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.done

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:125](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L125)

***

<div id="ratelimited">
  ### rateLimited
</div>

• `get` **rateLimited**(): `boolean`

Comprueba si se alcanzó el límite de tasa

<div id="returns">
  #### Devuelve
</div>

`boolean`

<div id="inherited-from">
  #### Heredado de
</div>

Paginator.rateLimited

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:132](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L132)

***

<div id="users">
  ### usuarios
</div>

• `get` **users**(): `any`\[]

<div id="returns">
  #### Devuelve
</div>

`any`\[]

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:351](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L351)

<div id="methods">
  ## Métodos
</div>

<div id="fetchnext">
  ### fetchNext
</div>

▸ **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.

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`void`>

**`Ejemplo`**

```typescript theme={null}
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

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[fetchNext](/es/xdks/typescript/reference/classes/Paginator#fetchnext)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:156](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L156)

***

<div id="next">
  ### next
</div>

▸ **next**(): `Promise`\<[`Paginator`](/es/xdks/typescript/reference/classes/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.

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Paginator`](/es/xdks/typescript/reference/classes/Paginator)\<`any`>>

Nueva instancia de `Paginator` para la siguiente página

**`Ejemplo`**

```typescript theme={null}
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
}
```

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[next](/es/xdks/typescript/reference/classes/Paginator#next)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:211](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L211)

***

<div id="fetchprevious">
  ### fetchPrevious
</div>

▸ **fetchPrevious**(): `Promise`\<`void`>

Recupera la página anterior (si se admite)

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`void`>

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[fetchPrevious](/es/xdks/typescript/reference/classes/Paginator#fetchprevious)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:225](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L225)

***

<div id="previous">
  ### previous
</div>

▸ **previous**(): `Promise`\<[`Paginator`](/es/xdks/typescript/reference/classes/Paginator)\<`any`>>

Obtiene la página anterior como una instancia nueva

<div id="returns">
  #### Devuelve
</div>

`Promise`\<[`Paginator`](/es/xdks/typescript/reference/classes/Paginator)\<`any`>>

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[previous](/es/xdks/typescript/reference/classes/Paginator#previous)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:260](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L260)

***

<div id="fetchlast">
  ### fetchLast
</div>

▸ **fetchLast**(`count`): `Promise`\<`void`>

Obtiene hasta la cantidad especificada de elementos adicionales

<div id="parameters">
  #### Parámetros
</div>

| Nombre  | type     |
| :------ | :------- |
| `count` | `number` |

<div id="returns">
  #### Devuelve
</div>

`Promise`\<`void`>

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[fetchLast](/es/xdks/typescript/reference/classes/Paginator#fetchlast)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:274](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L274)

***

<div id="reset">
  ### reset
</div>

▸ **reset**(): `void`

Restablece el paginador a su estado inicial

<div id="returns">
  #### Devuelve
</div>

`void`

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[reset](/es/xdks/typescript/reference/classes/Paginator#reset)

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:288](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L288)

***

<div id="iterator">
  ### \[iterator]
</div>

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

Iterador de todos los elementos recuperados

<div id="returns">
  #### Devuelve
</div>

`Iterator`\<`any`, `any`, `undefined`>

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[\[iterator\]](Paginator.md#\[iterator])

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:303](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L303)

***

<div id="asynciterator">
  ### \[asyncIterator]
</div>

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

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

<div id="returns">
  #### Devuelve
</div>

`AsyncIterator`\<`any`, `any`, `undefined`>

<div id="inherited-from">
  #### Heredado de
</div>

[Paginator](/es/xdks/typescript/reference/classes/Paginator).[\[asyncIterator\]](Paginator.md#\[asynciterator])

<div id="defined-in">
  #### Definido en
</div>

[paginator.ts:312](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L312)