ApiPlatformResponseOptions

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

Extends

• ResponseOptions

Constructors

Constructor

new ApiPlatformResponseOptions(options): ApiPlatformResponseOptions

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

Parameters

options

IPaginationConfig

Returns

ApiPlatformResponseOptions

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