Class OffsetLimitPage

packages/core/src/v3/apiClient/pagination.ts:97–163

}

export class OffsetLimitPage<Item>
  implements OffsetLimitPageResponse<Item>, Page<Item>, AsyncIterable<Item>
{
  data: Array<Item>;
  pagination: { currentPage: number; totalPages: number; count: number };

  constructor(
    data: Array<Item>,
    pagination: { currentPage: number; totalPages: number; count: number },
    private pageFetcher: (
      params: Omit<OffsetLimitPageParams, "limit">
    ) => Promise<OffsetLimitPage<Item>>
  ) {
    this.data = data;
    this.pagination = pagination;
  }

  getPaginatedItems(): Item[] {
    return this.data ?? [];
  }

  hasNextPage(): boolean {
    return this.pagination.currentPage < this.pagination.totalPages;
  }

  hasPreviousPage(): boolean {
    return this.pagination.currentPage > 1;
  }

  getNextPage(): Promise<OffsetLimitPage<Item>> {
    if (!this.hasNextPage()) {
      throw new Error("No next page available");
    }

    return this.pageFetcher({
      page: this.pagination.currentPage + 1,
    });
  }

  getPreviousPage(): Promise<OffsetLimitPage<Item>> {
    if (!this.hasPreviousPage()) {
      throw new Error("No previous page available");
    }

    return this.pageFetcher({
      page: this.pagination.currentPage - 1,
    });
  }

  async *iterPages() {
    // eslint-disable-next-line @typescript-eslint/no-this-alias
    let page: OffsetLimitPage<Item> = this;
    yield page;
    while (page.hasNextPage()) {
      page = await page.getNextPage();
      yield page;
    }
  }