Type Alias CustomPagerParser<TItem, TRequest, TResponse>`Template`

CustomPagerParser: (
    request: TRequest,
    response: WithRawResponse<TResponse>,
) => Promise<
    {
        nextRequest?: TRequest;
        hasNextPage: boolean;
        previousRequest?: TRequest;
        hasPreviousPage: boolean;
        items: TItem[];
    },
>

Parser function type for custom pagination. SDK authors implement this to define how to extract items and determine pagination state.

TItem The type of items in the paginated response. TRequest The type of the request object. TResponse The type of the API response.

Type Parameters

TItem
TRequest
TResponse

Type Declaration

- (
      request: TRequest,
      response: WithRawResponse<TResponse>,
  ): Promise<
      {
          nextRequest?: TRequest;
          hasNextPage: boolean;
          previousRequest?: TRequest;
          hasPreviousPage: boolean;
          items: TItem[];
      },
  >
- Parameters
  - request: TRequest
  - response: WithRawResponse<TResponse>
  Returns Promise<
      {
          nextRequest?: TRequest;
          hasNextPage: boolean;
          previousRequest?: TRequest;
          hasPreviousPage: boolean;
          items: TItem[];
      },
  >

Type Alias CustomPagerParser<TItem, TRequest, TResponse>Template

Type Parameters

Type Declaration

Parameters

Returns Promise< { nextRequest?: TRequest; hasNextPage: boolean; previousRequest?: TRequest; hasPreviousPage: boolean; items: TItem[]; },>

Settings

Type Alias CustomPagerParser<TItem, TRequest, TResponse>`Template`

Returns Promise<
{
nextRequest?: TRequest;
hasNextPage: boolean;
previousRequest?: TRequest;
hasPreviousPage: boolean;
items: TItem[];
},
>