Paginator

X API paginator with rich functionality This class provides comprehensive pagination support for the X API, including:

Automatic iteration with for await...of loops
Manual page control with fetchNext() and fetchPrevious()
Metadata access for pagination tokens and counts
Error handling and rate limit detection
Support for both forward and backward pagination

Example

Example

// 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); // Next page token

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

Type parameters

Name	Description
`T`	The type of items being paginated

Jerarquía

Paginator ↳ PostPaginator ↳ UserPaginator ↳ EventPaginator

Implements

AsyncIterable<T>

Constructores

constructor

• new Paginator<T>(fetchPage): Paginator<T> Creates a new paginator instance

Parámetros de tipo

Name
`T`

Parámetros

Nombre	Tipo	Descripción
`fetchPage`	(`token?`: `string`) => `Promise`<`PaginatedResponse`<`T`>>	Function that fetches a page of data given a pagination token

Devuelve

Paginator<T>

Definido en

paginator.ts:90

Accessors

items

• get items(): T[] Get all fetched items

Devuelve

T[]

Definido en

paginator.ts:97

includes

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

Devuelve

undefined | Record<string, any>

Definido en

paginator.ts:111

errors

• get errors(): undefined | any[] Get current errors

Devuelve

undefined | any[]

Definido en

paginator.ts:118

done

• get done(): boolean Check if pagination is done

Devuelve

boolean

Definido en

paginator.ts:125

rateLimited

• get rateLimited(): boolean Check if rate limit was hit

Devuelve

boolean

Definido en

paginator.ts:132

Métodos

fetchNext

▸ fetchNext(): Promise<void> Fetch the next page and add items to current instance This method fetches the next page of data and appends the items to the current paginator instance. It updates the pagination state and metadata.

Devuelve

Promise<void> Example

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Fetch first page
console.log(followers.items.length); // Number of followers

if (!followers.done) {
  await followers.fetchNext(); // Fetch second page
  console.log(followers.items.length); // Total followers across pages
}

Throws When the API request fails

Definido en

paginator.ts:156

▸ next(): Promise<Paginator<T>> Get next page as a new instance This method creates a new paginator instance that starts from the next page, without affecting the current paginator’s state.

Devuelve

Promise<Paginator<T>> New paginator instance for the next page Example

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // Fetch first page

if (!followers.done) {
  const nextPage = await followers.next(); // Get next page as new instance
  console.log(followers.items.length); // Still first page
  console.log(nextPage.items.length); // Second page
}

Definido en

paginator.ts:211

fetchPrevious

▸ fetchPrevious(): Promise<void> Fetch previous page (if supported)

Devuelve

Promise<void>

Definido en

paginator.ts:225

▸ previous(): Promise<Paginator<T>> Get previous page as a new instance

Devuelve

Promise<Paginator<T>>

Definido en

paginator.ts:260

fetchLast

▸ fetchLast(count): Promise<void> Fetch up to a specified number of additional items

Parámetros

Nombre	Tipo
`count`	`number`

Devuelve

Promise<void>

Definido en

paginator.ts:274

reset

▸ reset(): void Reset paginator to initial state

Devuelve

void

Definido en

paginator.ts:288

[iterator]

▸ [iterator](): Iterator<T, any, undefined> Iterator for all fetched items

Devuelve

Iterator<T, any, undefined>

Definido en

paginator.ts:303

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<T, any, undefined> Async iterator that fetches pages automatically

Devuelve

AsyncIterator<T, any, undefined>

Implementation of

AsyncIterable.[asyncIterator]

Definido en

paginator.ts:312

​Type parameters

​Jerarquía

​Implements

​Constructores

​constructor

​Parámetros de tipo

​Parámetros

​Devuelve

​Definido en

​Accessors

​items

​Devuelve

​Definido en

​meta

​Devuelve

​Definido en

​includes

​Devuelve

​Definido en

​errors

​Devuelve

​Definido en

​done

​Devuelve

​Definido en

​rateLimited

​Devuelve

​Definido en

​Métodos

​fetchNext

​Devuelve

​Definido en

​next

​Devuelve

​Definido en

​fetchPrevious

​Devuelve

​Definido en

​previous

​Devuelve

​Definido en

​fetchLast

​Parámetros

​Devuelve

​Definido en

​reset

​Devuelve

​Definido en

​[iterator]

​Devuelve

​Definido en

​[asyncIterator]

​Devuelve

​Implementation of

​Definido en

Type parameters

Jerarquía

Implements

Constructores

constructor

Parámetros de tipo

Parámetros

Devuelve

Definido en

Accessors

items

Devuelve

Definido en

meta

Devuelve

Definido en

includes

Devuelve

Definido en

errors

Devuelve

Definido en

done

Devuelve

Definido en

rateLimited

Devuelve

Definido en

Métodos

fetchNext

Devuelve

Definido en

next

Devuelve

Definido en

fetchPrevious

Devuelve

Definido en

previous

Devuelve

Definido en

fetchLast

Parámetros

Devuelve

Definido en

reset

Devuelve

Definido en

[iterator]

Devuelve

Definido en

[asyncIterator]

Devuelve

Implementation of

Definido en