Skip to content
qubeejs/angular
3.8/API/ApiPlatformResponseOptions

ApiPlatformResponseOptions

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:57

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

new ApiPlatformResponseOptions(options): ApiPlatformResponseOptions

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

IPaginationConfig

ApiPlatformResponseOptions

ResponseOptions.constructor

readonly currentPage: string

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

ResponseOptions.currentPage


readonly data: string

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

ResponseOptions.data


readonly firstPageUrl: string

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

ResponseOptions.firstPageUrl


readonly from: string

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

ResponseOptions.from


readonly lastPage: string

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

ResponseOptions.lastPage


readonly lastPageUrl: string

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

ResponseOptions.lastPageUrl


readonly nextPageUrl: string

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

ResponseOptions.nextPageUrl


readonly path: string

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

ResponseOptions.path


readonly perPage: string

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

ResponseOptions.perPage


readonly prevPageUrl: string

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

ResponseOptions.prevPageUrl


readonly to: string

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

ResponseOptions.to


readonly total: string

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

ResponseOptions.total