UserPaginator

ユーザー向けページネーター

​

階層構造

• Paginator<any>

  ↳ UserPaginator

​

コンストラクタ

​

constructor

• new UserPaginator(fetchPage): UserPaginator

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

​

パラメーター

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

​

返り値

UserPaginator

​

継承元

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 データを取得

​

戻り値

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

---

​

users

・get users(): any[]

​

返り値

any[]

​

定義元

paginator.ts:348

​

メソッド

​

fetchNext

▸ fetchNext(): Promise<void>

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

このメソッドは次のページのdataを取得し、取得した項目を現在のpaginatorインスタンスに追加します。ページネーションの状態と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 インスタンス

例

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<any, any, undefined>

​

継承元

Paginator.[iterator]

​

定義箇所

paginator.ts:300

---

​

[asyncIterator]

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

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

​

返却値

AsyncIterator<any, any, undefined>

​

継承元

Paginator.[asyncIterator]

​

定義場所

paginator.ts:309