Type alias NextableResponse<T>

NextableResponse<T>: {
    endpoint: string;
    params?: Api.Client.CollectionParams;
    headers: {
        [k: string]: string;
    };
    response: Api.CollectionResponse<T>;
}

A NextableResponse is a packet of information that makes it easy to go back and forth through paged results. This "freezes" the request parameters that were originally used to make the request and uses them to make subsequent requests for next (and previous) pages.

Type Parameters

  • T = unknown

Type declaration

  • endpoint: string
  • Optional params?: Api.Client.CollectionParams
  • headers: {
        [k: string]: string;
    }
    • [k: string]: string
  • response: Api.CollectionResponse<T>

Generated using TypeDoc