EventPaginator

イベント（DM イベントなど）をページネートするための Paginator

​

階層構造

• Paginator<any>

  ↳ EventPaginator

​

コンストラクタ

​

constructor

• new EventPaginator(fetchPage): EventPaginator

新しいページネーターのインスタンスを作成します

​

パラメータ

名前	型	説明
fetchPage	(token?: string) => Promise<PaginatedResponse<any>>	ページネーション・トークンを受け取り、該当ページのデータを取得する関数

​

戻り値

EventPaginator

​

継承元

Paginator.constructor

​

定義箇所

paginator.ts:87

​

アクセサー

​

items

• get items(): T[]

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

​

戻り値

T[]

​

継承元

Paginator.items

​

定義場所

paginator.ts:94

---

​

meta

• get meta(): any

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

​

戻り値

any

​

継承

Paginator.meta

​

定義箇所

paginator.ts:101

---

​

includes

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

現在の includes の data を取得します

​

戻り値

undefined | Record<string, any>

​

継承先

Paginator.includes

​

定義元

paginator.ts:108

---

​

errors

• get errors(): undefined | any[]

現在のエラーを取得します

​

戻り値

undefined | any[]

​

継承元

Paginator.errors

​

定義場所

paginator.ts:115

---

​

完了

• get done(): boolean

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

​

戻り値

boolean

​

継承元

Paginator.done

​

定義元

paginator.ts:122

---

​

rateLimited

• get rateLimited(): boolean

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

​

戻り値

boolean

​

継承元

Paginator.rateLimited

​

定義箇所

paginator.ts:129

---

​

events

• get events(): any[]

​

戻り値

any[]

​

定義場所

paginator.ts:359

​

メソッド

​

fetchNext

▸ fetchNext(): Promise<void>

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

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

​

返り値

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:153

---

​

next

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

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

このメソッドは、次ページから開始する新しい Paginator インスタンスを作成し、現在の Paginator の状態には影響しません。

​

戻り値

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:208

---

​

fetchPrevious

▸ fetchPrevious(): Promise<void>

前のページを取得します（対応している場合）

​

返り値

Promise<void>

​

継承元

Paginator.fetchPrevious

​

定義箇所

paginator.ts:222

---

​

previous

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

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

​

戻り値

Promise<Paginator<any>>

​

継承元

Paginator.previous

​

定義場所

paginator.ts:257

---

​

fetchLast

▸ fetchLast(count): Promise<void>

指定した数までの追加項目を取得します

​

パラメーター

項目名	型
count	number

​

戻り値

Promise<void>

​

継承元

Paginator.fetchLast

​

定義箇所

paginator.ts:271

---

​

reset

▸ reset(): void

ページネーターを初期状態に戻します

​

返り値

void

​

継承元

Paginator の reset

​

定義場所

paginator.ts:285

---

​

[iterator]

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

取得済みのすべてのアイテムを走査する Iterator

​

戻り値

Iterator<any, any, undefined>

​

継承元

Paginator.[iterator]

​

定義箇所

paginator.ts:300

---

​

[asyncIterator]

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

ページを自動取得する非同期イテレーター

​

戻り値

AsyncIterator<any, any, undefined>

​

継承元

Paginator.[asyncIterator]

​

定義元

paginator.ts:309