> ## 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

Pagineur pour les utilisateurs

<div id="hierarchy">
  ## Hiérarchie
</div>

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

  ↳ **`UserPaginator`**

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

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

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

Crée une nouvelle instance de `UserPaginator`

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type                                                                                                                          | Description                                                                 |
| :---------- | :---------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- |
| `fetchPage` | (`token?`: `string`) => `Promise`\<[`PaginatedResponse`](/fr/xdks/typescript/reference/interfaces/PaginatedResponse)\<`any`>> | Fonction qui récupère une page de données pour un jeton de pagination donné |

#### Renvoie

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

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

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

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

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

Renvoie tous les éléments récupérés

#### Renvoie

`T`\[]

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.items

#### Défini dans

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

***

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

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

Récupère les métadonnées de pagination actuelles

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

`any`

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.meta

#### Défini dans

[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`>

Récupère les données actuelles de la section includes.

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

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

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.includes

#### Défini dans

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

***

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

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

Récupère les errors actuelles

#### Renvoie

`undefined` | `any`\[]

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.errors

#### Défini dans

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

***

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

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

Vérifie si la pagination est terminée.

#### Renvoie

`boolean`

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.done

#### Défini dans

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

***

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

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

Vérifier si la limite de débit a été atteinte

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

`boolean`

<div id="inherited-from">
  #### Hérité de
</div>

Paginator.rateLimited

#### Défini dans

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

***

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

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

#### Renvoie

`any`\[]

#### Défini dans

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

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

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

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

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

Cette méthode récupère la page suivante de données et ajoute les éléments à
l’instance actuelle du paginateur. Elle met à jour l’état de la pagination et les métadonnées.

#### Renvoie

`Promise`\<`void`>

**`Exemple`**

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

Lorsque la requête d’API échoue

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

***

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

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

Récupérer la page suivante sous la forme d'une nouvelle instance

Cette méthode crée une nouvelle instance de Paginator qui démarre à partir de la page suivante,
sans affecter l'état du Paginator actuel.

#### Renvoie

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

Nouvelle instance de `Paginator` pour la page suivante

**`Exemple`**

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

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

***

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

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

Récupère la page précédente (si elle est prise en charge)

#### Renvoie

`Promise`\<`void`>

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

***

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

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

Récupère la page précédente en tant que nouvelle instance

#### Renvoie

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

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

***

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

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

Récupère jusqu’au nombre spécifié d’éléments supplémentaires

<div id="parameters">
  #### Paramètres
</div>

| Nom     | Type     |
| :------ | :------- |
| `count` | `number` |

#### Renvoie

`Promise`\<`void`>

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

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

***

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

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

Réinitialise le paginator à son état initial.

#### Renvoie

`void`

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Définie dans

[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`>

Itérateur sur l’ensemble des éléments récupérés

#### Renvoie

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

<div id="inherited-from">
  #### Hérité de
</div>

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

#### Défini dans

[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`>

Itérateur asynchrone qui récupère les pages automatiquement

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

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

<div id="inherited-from">
  #### Hérité de
</div>

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

<div id="defined-in">
  #### Définition dans
</div>

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