Class CustomPager<TItem, TRequest, TResponse>Template

hasNextPage

• hasNextPage(): boolean

  Returns boolean

  whether there is a next page to load

hasPreviousPage

• hasPreviousPage(): boolean

  Returns boolean

  whether there is a previous page to load

getNextPage

• getNextPage(): Promise<CustomPager<TItem, TRequest, TResponse>>

  Retrieves the next page of results.

  Returns Promise<CustomPager<TItem, TRequest, TResponse>>

  this pager with updated data

  Throws

  Error if there is no next page

getPreviousPage

• getPreviousPage(): Promise<CustomPager<TItem, TRequest, TResponse>>

  Retrieves the previous page of results.

  Returns Promise<CustomPager<TItem, TRequest, TResponse>>

  this pager with updated data

  Throws

  Error if there is no previous page

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<TItem, void, unknown>

  Returns AsyncIterator<TItem, void, unknown>

Staticcreate

• create<TItem, TRequest, TResponse>(
      args: {
          sendRequest: (request: TRequest) => HttpResponsePromise<TResponse>;
          initialRequest: TRequest;
          parse: CustomPagerParser<TItem, TRequest, TResponse>;
      },
  ): Promise<CustomPager<TItem, TRequest, TResponse>>

  Creates a CustomPager by making the initial request and parsing the response.

  Type Parameters

  • TItem
  • TRequest
  • TResponse

  Parameters

  • args: {
        sendRequest: (request: TRequest) => HttpResponsePromise<TResponse>;
        initialRequest: TRequest;
        parse: CustomPagerParser<TItem, TRequest, TResponse>;
    }

    • sendRequest: (request: TRequest) => HttpResponsePromise<TResponse>

      Function to send a request and get a response

    • initialRequest: TRequest

      The initial request to start pagination

    • parse: CustomPagerParser<TItem, TRequest, TResponse>

      The parser function to extract items and pagination state

  Returns Promise<CustomPager<TItem, TRequest, TResponse>>

  A new CustomPager instance

data

rawResponse

response