FastapiResponseStrategy

src/strategies/fastapi-response.strategy.ts1 public methodsclass

Response strategy for the FastAPI driver

Parses the body of fastapi-pagination’s Page:

{
  "items": [{ "id": 11, "title": "Hello" }],
  "total": 95,
  "page": 2,
  "size": 10,
  "pages": 10
}

Default key paths are configured in FastapiResponseOptions. A plain Page has no navigation links, so the URLs resolve to undefined; fastapi_pagination.links.Page adds a links block whose first, prev, next and last are read with the same defaults.

fastapi-pagination sends null for what it does not know: total and pages under UseIncludeTotal(False), and prev/next at either end of links. Every field is read by type, so a null comes out as undefined, the collection’s “not known”. Without a total, fastapi-pagination also points links.last at page 1 whatever the page count, so that link is dropped rather than passed on.

from/to are derived from the rows actually returned: page × size places the first row and the row count the last, so a short last page ends at its last row with or without a total, and an empty page (no results, or a page past the end) has neither. An empty result reports pages: 0; the last page is clamped to 1 so Paginator still syncs it and a stale page count from an earlier, wider query does not survive.

Constructor

new FastapiResponseStrategy()

Methods

paginate()

paginate(response: RawResponse, options: ResponseOptions): PaginatedCollection<T>

Parse a fastapi-pagination Page body into a PaginatedCollection

Parameter	Type	Description
response	RawResponse	The raw API response body
options	ResponseOptions	The response key name configuration; from and to are derived rather than read

Returns — A typed PaginatedCollection instance