Skip to main content
Version: 3.7.0

SpringResponseOptions

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

Pre-configured ResponseOptions for the Spring Data REST driver

Uses dot-notation paths into the HAL envelope: pagination metadata lives under page.* and navigation links under _links.*.href. currentPage points at the 0-indexed page.number; the strategy adds 1 when reading it. data defaults to plain _embedded because the collection key underneath is the resource rel name (e.g. _embedded.users) and cannot be known statically — the strategy picks the first array inside; pin an exact path via IPaginationConfig when needed. from/to default to empty paths and are derived.

Extends

Constructors

Constructor

new SpringResponseOptions(options): SpringResponseOptions

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

Parameters

options

IPaginationConfig

Returns

SpringResponseOptions

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