페이지네이션

SDK는 페이지네이션된 응답을 반환하는 모든 엔드포인트에서 사용할 수 있는 범용 페이지네이터 유틸리티를 제공합니다. 메서드는 기본 응답을 반환하며, 이를 페이지네이터로 래핑해 사용합니다.

​

기본 페이지네이션

quick-start.ts

Typescript

import { Client, UserPaginator, PaginatedResponse, Schemas } from '@xdevplatform/xdk';

const client: Client = new Client({ bearerToken: 'your-bearer-token' });

// 모든 목록 엔드포인트를 올바른 타입으로 래핑
const followers: UserPaginator = new UserPaginator(
  async (token?: string): Promise<PaginatedResponse<Schemas.User>> => {
    const res = await client.users.getFollowers('<userId>', {
      maxResults: 100,
      paginationToken: token,
      userfields: ['id','name','username'],
    });
    return { 
      data: res.data ?? [], 
      meta: res.meta, 
      includes: res.includes, 
      errors: res.errors 
    };
  }
);

​

수동 페이징

manual.ts

import { UserPaginator, Schemas } from '@xdevplatform/xdk';

await followers.fetchNext();          // 첫 페이지
while (!followers.done) {
  await followers.fetchNext();        // 다음 페이지들
}

const userCount: number = followers.users.length;  // 가져온 모든 사용자 수
const firstUser: Schemas.User | undefined = followers.users[0];
const nextToken: string | undefined = followers.meta?.next_token;

​

비동기 반복

async.ts

import { Schemas } from '@xdevplatform/xdk';

for await (const user of followers) {
  const typedUser: Schemas.User = user;
  console.log(typedUser.username);  // 완전한 타입 기반 접근
}

​

다음 페이지를 새 인스턴스로 가져오기

next.ts

import { UserPaginator } from '@xdevplatform/xdk';

await followers.fetchNext();
if (!followers.done) {
  const page2: UserPaginator = await followers.next(); // 다음 페이지에서 시작하는 독립적인 페이지네이터
  await page2.fetchNext();
  console.log(page2.users.length);  // 두 번째 페이지의 항목
}

​

오류 처리와 속도 제한

errors.ts

import { UserPaginator, Schemas } from '@xdevplatform/xdk';

try {
  for await (const item of followers) {
    const user: Schemas.User = item;
    // 사용자 처리...
  }
} catch (err: unknown) {
  if (followers.rateLimited) {
    console.error('속도 제한에 걸렸습니다. 백오프가 필요합니다');
    // 백오프 / 나중에 재시도
  } else {
    console.error('페이지네이션 오류:', err);
    throw err;
  }
}