Skip to main content
Version: 3.8.0

DirectusResponseOptions

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

Pre-configured ResponseOptions for the Directus driver

The Directus envelope is { data, meta: { total_count, filter_count } } (with meta=total_count,filter_count requested — the request strategy always emits it). total defaults to meta.filter_count, the count of items matching the current filter; point it at meta.total_count via IPaginationConfig for the unfiltered collection size. The envelope names no current page, page size, or navigation URLs, so those paths default to empty strings — the strategy falls back to page 1 and derives lastPage/from/to only when the response provably holds the whole filtered set. All paths are overridable (dot notation supported) for custom wrappers that do include paging fields.

Extends​

Constructors​

Constructor​

new DirectusResponseOptions(options): DirectusResponseOptions

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

Parameters​

options​

IPaginationConfig

Returns​

DirectusResponseOptions

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