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

階層

Paginator ↳ PostPaginator ↳ UserPaginator ↳ EventPaginator

Implements

AsyncIterable<T>

コンストラクター

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

型パラメーター

Name
`T`

パラメーター

名前	型	説明
`fetchPage`	(`token?`: `string`) => `Promise`<`PaginatedResponse`<`T`>>	Function that fetches a page of data given a pagination token

戻り値

Paginator<T>

定義場所

paginator.ts:90

Accessors

items

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

戻り値

T[]

定義場所

paginator.ts:97

includes

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

戻り値

undefined | Record<string, any>

定義場所

paginator.ts:111

errors

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

戻り値

undefined | any[]

定義場所

paginator.ts:118

done

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

戻り値

boolean

定義場所

paginator.ts:125

rateLimited

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

戻り値

boolean

定義場所

paginator.ts:132

メソッド

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.

戻り値

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

定義場所

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.

戻り値

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
}

定義場所

paginator.ts:211

fetchPrevious

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

戻り値

Promise<void>

定義場所

paginator.ts:225

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

戻り値

Promise<Paginator<T>>

定義場所

paginator.ts:260

fetchLast

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

パラメーター

名前	型
`count`	`number`

戻り値

Promise<void>

定義場所

paginator.ts:274

reset

▸ reset(): void Reset paginator to initial state

戻り値

void

定義場所

paginator.ts:288

[iterator]

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

戻り値

Iterator<T, any, undefined>

定義場所

paginator.ts:303

[asyncIterator]

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

戻り値

AsyncIterator<T, any, undefined>

実装元

AsyncIterable.[asyncIterator]

定義場所

paginator.ts:312

​Type parameters

​階層

​Implements

​コンストラクター

​コンストラクター

​型パラメーター

​パラメーター

​戻り値

​定義場所

​Accessors

​items

​戻り値

​定義場所

​meta

​戻り値

​定義場所

​includes

​戻り値

​定義場所

​errors

​戻り値

​定義場所

​done

​戻り値

​定義場所

​rateLimited

​戻り値

​定義場所

​メソッド

​fetchNext

​戻り値

​定義場所

​next

​戻り値

​定義場所

​fetchPrevious

​戻り値

​定義場所

​previous

​戻り値

​定義場所

​fetchLast

​パラメーター

​戻り値

​定義場所

​reset

​戻り値

​定義場所

​[iterator]

​戻り値

​定義場所

​[asyncIterator]

​戻り値

​実装元

​定義場所

Type parameters

階層

Implements

コンストラクター

コンストラクター

型パラメーター

パラメーター

戻り値

定義場所

Accessors

items

戻り値

定義場所

meta

戻り値

定義場所

includes

戻り値

定義場所

errors

戻り値

定義場所

done

戻り値

定義場所

rateLimited

戻り値

定義場所

メソッド

fetchNext

戻り値

定義場所

next

戻り値

定義場所

fetchPrevious

戻り値

定義場所

previous

戻り値

定義場所

fetchLast

パラメーター

戻り値

定義場所

reset

戻り値

定義場所

[iterator]

戻り値

定義場所

[asyncIterator]

戻り値

実装元

定義場所