API/ApiPlatformResponseOptions
ApiPlatformResponseOptions
src/models/response-options.tsclass
Pre-configured ResponseOptions for the API Platform (Symfony) driver
Uses dot-notation paths into the Hydra/JSON-LD envelope — the Hydra
keys contain colons but no dots, so hydra:view.hydra:next traverses
response['hydra:view']['hydra:next']. The path slot points at the
view’s @id, which the strategy parses for the current page and page
size; currentPage / perPage / lastPage have no body field and
default to empty paths (derived from the view URLs instead).
Constructor
Section titled “Constructor”new ApiPlatformResponseOptions(options: PaginationConfig)| Parameter | Type | Description |
|---|---|---|
options |
PaginationConfig |
— |
Properties
Section titled “Properties”| 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 |
— |