Pagination

[rimo030]

페이지네이션

페이지네이션은 데이터를 여러 페이지로 나누어 보여주는 기능입니다.
일반적으로 클라이언트가 페이지 번호와 페이지 크기를 요청에 보내면, 서버는 해당 페이지에 대한 데이터를 반환합니다.

• Requst
  클라이언트에서 현재 페이지 번호(page)와 한 페이지에 보여줄 데이터 수(limit)를 요청으로 보냅니다.
• Response
  데이터를 포함한 메타 정보(totalCount, totalPage, page, take)를 제공합니다.

이 프로젝트에서는 PagenationUtil을 정의해 관련 기능을 지원합니다.

• src/util/pagination.util.ts

[rimo030]

PaginationUtil 유틸 함수 설명

1. 요청 / 응답 인터페이스

export interface Request {
  page?: number | null;
  limit?: number | null;
}

• page: 요청한 페이지 번호.
  • 기본적으로 0 또는 1 페이지부터 시작하도록 처리됨
• limit : 한 페이지에 가져올 데이터의 최대 개수.
  • 값이 없을 경우 기본값(예: 10)으로 설정됨.

export interface Response<T> {
  data: T[] & tags.MinItems<0>;
  meta: {
    page: number & tags.Type<'int64'>;
    take: number & tags.Type<'int64'>;
    totalCount: number & tags.Type<'int64'>;
    totalPage: number & tags.Type<'int64'>;
  };
}

• data: 제네릭(T) 타입의 배열.

  • 페이지네이션으로 가져온 실제 데이터가 담김.
  • tags.MinItems<0>: 데이터 배열의 최소 길이를 보장(여기선 0).

• meta : 페이지네이션에 대한 메타 정보를 담은 객체.

  • page: 현재 페이지 번호.
  • take: 한 페이지당 가져온 데이터 수.
  • totalCount: 전체 데이터 개수.
  • totalPage: 전체 페이지 수

[rimo030]

2. getOffset 함수

요청한 페이지에 따라 데이터를 얼마나 건너뛸지(skip)와 가져올 데이터 개수(take)를 계산합니다.

export function getOffset(input: Request): { skip: number; take: number }

3. getTotalPage 함수

전체 데이터를 기준으로 총 페이지 수를 계산합니다.

export function getTotalPage(totalCount: number, limit: number): number

4. createResponse 함수

페이지네이션 응답 형식을 만듭니다.

export function createResponse<T>(input: { data: T[], skip: number, count: number, take: number }): Response<T>