Skip to content
API/ResponseOptions

ResponseOptions

src/models/response-options.tsclass

Resolved response field key names with defaults applied

Maps logical pagination concepts to the actual key names used in the API response. Unset values fall back to Laravel defaults.

For NestJS responses, use dot-notation paths:

new ResponseOptions({
currentPage: 'meta.currentPage',
total: 'meta.totalItems'
});
new ResponseOptions(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 —