UserPaginator

ユーザー用のページネーター

継承階層

• Paginator<any>

  ↳ UserPaginator

コンストラクタ

constructor

• new UserPaginator(fetchPage): UserPaginator

新しい paginator インスタンスを生成します

パラメーター

Name	Type	Description
fetchPage	(token?: string) => Promise<PaginatedResponse<any>>	ページネーショントークンを受け取り、1ページ分のデータを取得する関数

戻り値

UserPaginator

継承元

Paginator.constructor

定義元

paginator.ts:90

アクセサ

items

• get items(): T[]

フェッチ済みのアイテムをすべて取得します

戻り値

T[]

継承元

Paginator.items

定義場所

paginator.ts:97

---

meta

• get meta(): any

現在のページネーションのメタデータを取得します。

戻り値

any

継承元

Paginator.meta

定義元

paginator.ts:104

---

includes

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

現在の includes データを取得します。

戻り値

undefined | Record<string, any>

継承元

Paginator.includes

定義元

paginator.ts:111

---

errors

• get errors(): undefined | any[]

現在の errors を取得します

戻り値

undefined | any[]

継承元

Paginator.errors

定義元

paginator.ts:118

---

done

• get done(): boolean

ページネーションが完了しているかどうかを確認します

戻り値

boolean

継承元

Paginator.done

定義元

paginator.ts:125

---

rateLimited

• get rateLimited(): boolean

レート制限に達したかどうかを確認します。

戻り値

boolean

継承元

Paginator.rateLimited

定義場所

paginator.ts:132

---

users

• get users(): any[]

戻り値

any[]

定義元

paginator.ts:351

メソッド

fetchNext

▸ fetchNext(): Promise<void>

次のページを取得し、現在のインスタンスにアイテムを追加します。

このメソッドは、次のページのデータを取得し、そのアイテムを現在のページネーターインスタンスに追加します。ページネーションの状態とメタデータを更新します。

戻り値

Promise<void>

使用例

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // 最初のページを取得
console.log(followers.items.length); // フォロワーの数

if (!followers.done) {
  await followers.fetchNext(); // 2ページ目を取得
  console.log(followers.items.length); // ページ全体のフォロワー総数
}

Throws

API リクエストが失敗した場合に例外をスローします

継承元

Paginator.fetchNext

定義元

paginator.ts:156

---

next

▸ next(): Promise<Paginator<any>>

次のページを新しいインスタンスとして取得します。

このメソッドは、現在の paginator の状態に影響を与えることなく、次のページから開始される新しい paginator インスタンスを作成します。

Returns

Promise<Paginator<any>>

次のページに対する新しい Paginator インスタンス

Example

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // 最初のページを取得

if (!followers.done) {
  const nextPage = await followers.next(); // 次のページを新しいインスタンスとして取得
  console.log(followers.items.length); // まだ最初のページ
  console.log(nextPage.items.length); // 2ページ目
}

継承元

Paginator.next

定義場所

paginator.ts:211

---

fetchPrevious

▸ fetchPrevious(): Promise<void>

前のページを取得します (サポートされている場合)

戻り値

Promise<void>

継承元

Paginator.fetchPrevious

定義元

paginator.ts:225

---

previous

▸ previous(): Promise<Paginator<any>>

前のページを新しいインスタンスとして取得します。

戻り値

Promise<Paginator<any>>

継承元

Paginator.previous

定義場所

paginator.ts:260

---

fetchLast

▸ fetchLast(count): Promise<void>

最大で指定した数の追加アイテムを取得します

パラメーター

名前	type
count	number

戻り値

Promise<void>

継承元

Paginator.fetchLast

定義元

paginator.ts:274

---

reset

▸ reset(): void

ページネーターを初期状態にリセットします

戻り値

void

継承元

Paginator.reset

定義元

paginator.ts:288

---

[iterator]

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

取得済みのすべてのアイテムを反復処理するイテレーター

戻り値

Iterator<any, any, undefined>

継承元

Paginator.[iterator]

定義元

paginator.ts:303

---

[asyncIterator]

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

ページを自動的にフェッチする非同期イテレーター

戻り値

AsyncIterator<any, any, undefined>

継承元

Paginator.[asyncIterator]

定義場所

paginator.ts:312