API/JsonApiResponseOptions
JsonApiResponseOptions
src/models/response-options.tsclass
Pre-configured ResponseOptions for the JSON:API driver
Uses dot-notation paths to access nested values in the JSON:API response format.
JSON:API meta key names vary by implementation; these defaults cover the most
common conventions and can be fully customised via PaginationConfig.
Constructor
Section titled “Constructor”new JsonApiResponseOptions(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 |
— |