dce-mango/src/types/PaginatedResponse.ts

Harvard DCE's Non-relational DB Wrapper.

/**
 * A paginated response object.
 * @author Yuen Ler Chow
 */
type PaginatedResponse<DocumentType extends { [key: string]: any }> = {
  // The items on the current page.
  items: DocumentType[],
  // The current page number.
  currentPageNumber: number,
  // The number of items per page.
  perPage: number,
  // If true, there is another page.
  hasAnotherPage: boolean,
};

export default PaginatedResponse;