Application Load

IApiPagination

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IApiPagination

Backend pagination state.

interfaces/orionplace/accounts/IProfileData.ts
TypeScript
export interface IApiPagination {
  // Whether a following page exists.
  has_next: boolean;
  // Whether a preceding page exists.
  has_previous: boolean;
  // Whether pagination reports other pages.
  has_other_pages: boolean;
  // Next page number, null at the end; true can occur in the invalid-page
  // fallback.
  next_page_number: number | true | null;
  // Previous page number, or null.
  previous_page_number: number | null;
  // First result index on this page; zero for an empty page.
  start_index: number;
  // Last result index on this page; zero for an empty page.
  end_index: number;
  // Requested page number.
  page: number;
  // Count before request filters within the endpoint’s account scope.
  total_count?: number;
  // Count after request filters.
  selected_count?: number;
  // Total result pages.
  pages?: number;
}