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();
}

Parâmetros de tipo

Nome	Descrição
`T`	The type of items being paginated

Hierarquia

Paginator ↳ PostPaginator ↳ UserPaginator ↳ EventPaginator

Implements

AsyncIterable<T>

Construtores

constructor

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

Parâmetros de tipo

Name
`T`

Parâmetros

Nome	Tipo	Descrição
`fetchPage`	(`token?`: `string`) => `Promise`<`PaginatedResponse`<`T`>>	Function that fetches a page of data given a pagination token

Retorna

Paginator<T>

Definido em

paginator.ts:90

Acessadores

items

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

Retorna

T[]

Definido em

paginator.ts:97

includes

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

Retorna

undefined | Record<string, any>

Definido em

paginator.ts:111

errors

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

Retorna

undefined | any[]

Definido em

paginator.ts:118

done

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

Retorna

boolean

Definido em

paginator.ts:125

rateLimited

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

Retorna

boolean

Definido em

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.

Retorna

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 em

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.

Retorna

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 em

paginator.ts:211

fetchPrevious

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

Retorna

Promise<void>

Definido em

paginator.ts:225

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

Retorna

Promise<Paginator<T>>

Definido em

paginator.ts:260

fetchLast

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

Parâmetros

Nome	Tipo
`count`	`number`

Retorna

Promise<void>

Definido em

paginator.ts:274

reset

▸ reset(): void Reset paginator to initial state

Retorna

void

Definido em

paginator.ts:288

[iterator]

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

Retorna

Iterator<T, any, undefined>

Definido em

paginator.ts:303

[asyncIterator]

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

Retorna

AsyncIterator<T, any, undefined>

Implementação de

AsyncIterable.[asyncIterator]

Definido em

paginator.ts:312

​Parâmetros de tipo

​Hierarquia

​Implements

​Construtores

​constructor

​Parâmetros de tipo

​Parâmetros

​Retorna

​Definido em

​Acessadores

​items

​Retorna

​Definido em

​meta

​Retorna

​Definido em

​includes

​Retorna

​Definido em

​errors

​Retorna

​Definido em

​done

​Retorna

​Definido em

​rateLimited

​Retorna

​Definido em

​Métodos

​fetchNext

​Retorna

​Definido em

​next

​Retorna

​Definido em

​fetchPrevious

​Retorna

​Definido em

​previous

​Retorna

​Definido em

​fetchLast

​Parâmetros

​Retorna

​Definido em

​reset

​Retorna

​Definido em

​[iterator]

​Retorna

​Definido em

​[asyncIterator]

​Retorna

​Implementação de

​Definido em

Parâmetros de tipo

Hierarquia

Implements

Construtores

constructor

Parâmetros de tipo

Parâmetros

Retorna

Definido em

Acessadores

items

Retorna

Definido em

meta

Retorna

Definido em

includes

Retorna

Definido em

errors

Retorna

Definido em

done

Retorna

Definido em

rateLimited

Retorna

Definido em

Métodos

fetchNext

Retorna

Definido em

next

Retorna

Definido em

fetchPrevious

Retorna

Definido em

previous

Retorna

Definido em

fetchLast

Parâmetros

Retorna

Definido em

reset

Retorna

Definido em

[iterator]

Retorna

Definido em

[asyncIterator]

Retorna

Implementação de

Definido em