3.8/API/ResponseOptions

ResponseOptions

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

Resolved response field key names with defaults applied

Maps logical pagination concepts to the actual key names used in the API response. Unset values fall back to Laravel defaults.

For NestJS responses, use dot-notation paths:

new ResponseOptions({
  currentPage: 'meta.currentPage',
  total: 'meta.totalItems'
});

Extended by

Constructors

Constructor

new ResponseOptions(options): ResponseOptions

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

Parameters

options

IPaginationConfig

Returns

ResponseOptions

Properties

currentPage

readonly currentPage: string

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

data

readonly data: string

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

firstPageUrl

readonly firstPageUrl: string

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

from

readonly from: string

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

lastPage

readonly lastPage: string

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

lastPageUrl

readonly lastPageUrl: string

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

nextPageUrl

readonly nextPageUrl: string

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

path

readonly path: string

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

perPage

readonly perPage: string

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

prevPageUrl

readonly prevPageUrl: string

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

to

readonly to: string

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

total

readonly total: string

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