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，并将条目追加到当前分页器实例，同时更新分页状态和meta信息。

​

返回

Promise<void>

示例

const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // 获取第一页
console.log(followers.items.length); // 关注者数量

if (!followers.done) {
  await followers.fetchNext(); // 获取第二页
  console.log(followers.items.length); // 所有页面的关注者总数
}

Throws

API 请求失败时抛出

​

继承自

Paginator.fetchNext

​

定义于

paginator.ts:153

---

​

next

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

以新实例获取下一页

此方法会创建一个从下一页开始的新分页器实例， 且不会影响当前分页器的状态。

​

返回

Promise<Paginator<any>>

用于获取下一页的新分页器实例

示例

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); // 第二页
}

​

继承自

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