UserPaginator

사용자용 페이지네이터

​

계층 구조

• Paginator<any>

  ↳ UserPaginator

​

생성자

​

constructor

• new UserPaginator(fetchPage): UserPaginator

새로운 UserPaginator 인스턴스를 생성합니다

​

매개변수

Name	Type	Description
fetchPage	(token?: string) => Promise<PaginatedResponse<any>>	페이지네이션 토큰을 받아 데이터의 한 페이지를 가져오는 함수

​

반환값

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(); // 두 번째 페이지 가져오기
  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); // 두 번째 페이지
}

​

다음에서 상속됨

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