API/ListRequest
ListRequest
src/types/list-request.type.ts1 public methodstype
Everything needed to fetch one page of a list and read the answer, as
buildListRequest() builds it. The app performs the I/O.
[uri, headers] is a complete cache key — TanStack Query’s queryKey,
SWR’s key.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
headers |
Readonly<Record<string, string>> | null |
Headers the driver wants on the request — PostgREST’s Range in RANGE mode — or null. |
uri |
string |
The API URI, starting with the base URL when the list’s qubee config has one. |
Methods
Section titled “Methods”paginate()
Section titled “paginate()”paginate(response: RawResponse, headers?: HeaderBag): PaginatedCollection<T>Parse a response body with the paginator of the instance that built uri.
| Parameter | Type | Description |
|---|---|---|
response |
RawResponse |
The body, as the backend returned it |
headers |
HeaderBag |
The response headers, for drivers that page over them |
Returns — The rows and the page metadata