Type Alias PageFetcher<Page>

PageFetcher: (
page: number,
) => Promise<{ num_pages: number; page?: Nullable<Page> }>

A function that fetches a single page of data.

Type Parameters

Page
The type of data contained in a page

Type Declaration

- (page: number): Promise<{ num_pages: number; page?: Nullable<Page> }>
- Parameters
  - page: number
    Zero-based page index to fetch
  Returns Promise<{ num_pages: number; page?: Nullable<Page> }>
  A promise resolving to an object containing:
  - num_pages: Total number of pages available (may change between calls)
  - page: The page data, or null/undefined if the page is empty/unavailable

Example

const fetcher: PageFetcher<User[]> = async (page) => {
  const response = await api.getUsers({ page, limit: 100 });
  return {
    num_pages: response.totalPages,
    page: response.users
  };
};