Skip to content
API/SpringResponseOptions

SpringResponseOptions

src/models/response-options.tsclass

Pre-configured ResponseOptions for the Spring Data REST driver

Uses dot-notation paths into the HAL envelope: pagination metadata lives under page.* and navigation links under _links.*.href. currentPage points at the 0-indexed page.number; the strategy adds 1 when reading it. data defaults to plain _embedded because the collection key underneath is the resource rel name (e.g. _embedded.users) and cannot be known statically — the strategy picks the first array inside; pin an exact path via PaginationConfig when needed. from/to default to empty paths and are derived.

new SpringResponseOptions(options: PaginationConfig)
Parameter Type Description
options PaginationConfig —
Property Type Description
currentPage string —
data string —
firstPageUrl string —
from string —
lastPage string —
lastPageUrl string —
nextPageUrl string —
path string —
perPage string —
prevPageUrl string —
to string —
total string —