Skip to main content
Version: 3.7.0

JsonApiResponseOptions

Defined in: src/lib/models/response-options.ts:176

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 IPaginationConfig.

Extends​

Constructors​

Constructor​

new JsonApiResponseOptions(options): JsonApiResponseOptions

Defined in: src/lib/models/response-options.ts:177

Parameters​

options​

IPaginationConfig

Returns​

JsonApiResponseOptions

Overrides​

ResponseOptions.constructor

Properties​

currentPage​

readonly currentPage: string

Defined in: src/lib/models/response-options.ts:18

Inherited from​

ResponseOptions.currentPage

data​

readonly data: string

Defined in: src/lib/models/response-options.ts:19

Inherited from​

ResponseOptions.data

firstPageUrl​

readonly firstPageUrl: string

Defined in: src/lib/models/response-options.ts:20

Inherited from​

ResponseOptions.firstPageUrl

from​

readonly from: string

Defined in: src/lib/models/response-options.ts:21

Inherited from​

ResponseOptions.from

lastPage​

readonly lastPage: string

Defined in: src/lib/models/response-options.ts:22

Inherited from​

ResponseOptions.lastPage

lastPageUrl​

readonly lastPageUrl: string

Defined in: src/lib/models/response-options.ts:23

Inherited from​

ResponseOptions.lastPageUrl

nextPageUrl​

readonly nextPageUrl: string

Defined in: src/lib/models/response-options.ts:24

Inherited from​

ResponseOptions.nextPageUrl

path​

readonly path: string

Defined in: src/lib/models/response-options.ts:25

Inherited from​

ResponseOptions.path

perPage​

readonly perPage: string

Defined in: src/lib/models/response-options.ts:26

Inherited from​

ResponseOptions.perPage

prevPageUrl​

readonly prevPageUrl: string

Defined in: src/lib/models/response-options.ts:27

Inherited from​

ResponseOptions.prevPageUrl

to​

readonly to: string

Defined in: src/lib/models/response-options.ts:28

Inherited from​

ResponseOptions.to

total​

readonly total: string

Defined in: src/lib/models/response-options.ts:29

Inherited from​

ResponseOptions.total