JsonApiResponseOptions
ArchivedThese are the docs for ng-qubee 3.8. Read the 4.0 docs for @qubeejs/angular.
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
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JsonApiResponseOptions(
options):JsonApiResponseOptions
Defined in: src/lib/models/response-options.ts:177
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”JsonApiResponseOptions
Overrides
Section titled “Overrides”Properties
Section titled “Properties”currentPage
Section titled “currentPage”
readonlycurrentPage:string
Defined in: src/lib/models/response-options.ts:18
Inherited from
Section titled “Inherited from”
readonlydata:string
Defined in: src/lib/models/response-options.ts:19
Inherited from
Section titled “Inherited from”firstPageUrl
Section titled “firstPageUrl”
readonlyfirstPageUrl:string
Defined in: src/lib/models/response-options.ts:20
Inherited from
Section titled “Inherited from”
readonlyfrom:string
Defined in: src/lib/models/response-options.ts:21
Inherited from
Section titled “Inherited from”lastPage
Section titled “lastPage”
readonlylastPage:string
Defined in: src/lib/models/response-options.ts:22
Inherited from
Section titled “Inherited from”lastPageUrl
Section titled “lastPageUrl”
readonlylastPageUrl:string
Defined in: src/lib/models/response-options.ts:23
Inherited from
Section titled “Inherited from”nextPageUrl
Section titled “nextPageUrl”
readonlynextPageUrl:string
Defined in: src/lib/models/response-options.ts:24
Inherited from
Section titled “Inherited from”
readonlypath:string
Defined in: src/lib/models/response-options.ts:25
Inherited from
Section titled “Inherited from”perPage
Section titled “perPage”
readonlyperPage:string
Defined in: src/lib/models/response-options.ts:26
Inherited from
Section titled “Inherited from”prevPageUrl
Section titled “prevPageUrl”
readonlyprevPageUrl:string
Defined in: src/lib/models/response-options.ts:27
Inherited from
Section titled “Inherited from”
readonlyto:string
Defined in: src/lib/models/response-options.ts:28
Inherited from
Section titled “Inherited from”
readonlytotal:string
Defined in: src/lib/models/response-options.ts:29