DirectusResponseStrategy
ArchivedThese are the docs for ng-qubee 3.8. Read the 4.0 docs for @qubeejs/angular.
Defined in: src/lib/strategies/directus-response.strategy.ts:41
Response strategy for the Directus driver
Parses Directus collection responses (with meta=total_count,filter_count
requested, which the request strategy always does):
{ "data": [{ "id": 1, "title": "Hello" }], "meta": { "total_count": 48, "filter_count": 12 }}The default total path is meta.filter_count — the number of items
matching the current filter, which is the relevant total for paging a
filtered collection (meta.total_count ignores filters; point the
total path at it via IPaginationConfig if that is what you want).
The envelope carries no current-page or page-size field, so:
currentPagefalls back to 1 unless acurrentPagepath is configured and resolves (only guaranteed correct for single-page results — track the requested page in your own state for multi-page UIs).perPageresolves only when aperPagepath is configured.lastPageisceil(total ÷ perPage)when both are known; on a response that provably holds the whole filtered set it resolves to 1.
Every key path is overridable via IPaginationConfig (dot notation
supported), so custom wrappers that do include paging fields map
without subclassing.
https://docs.directus.io/reference/query.html#meta
Extends
Section titled “Extends”AbstractDotPathResponseStrategy
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DirectusResponseStrategy():
DirectusResponseStrategy
Returns
Section titled “Returns”DirectusResponseStrategy
Inherited from
Section titled “Inherited from”AbstractDotPathResponseStrategy.constructor
Methods
Section titled “Methods”paginate()
Section titled “paginate()”paginate<
T>(response,options):PaginatedCollection<T>
Defined in: src/lib/strategies/directus-response.strategy.ts:51
Parse a Directus collection response into a PaginatedCollection
Type Parameters
Section titled “Type Parameters”T extends IPaginatedObject
Parameters
Section titled “Parameters”response
Section titled “response”Record<string, any>
The raw API response body
options
Section titled “options”The response key name configuration (dot-notation paths supported)
Returns
Section titled “Returns”A typed PaginatedCollection instance
Overrides
Section titled “Overrides”AbstractDotPathResponseStrategy.paginate
resolve()
Section titled “resolve()”
protectedresolve(response,path):unknown
Defined in: src/lib/strategies/abstract-dot-path-response.strategy.ts:73
Resolve a value from a response object using a dot-notation path
Supports both flat keys ('data') and nested paths ('meta.totalItems').
Parameters
Section titled “Parameters”response
Section titled “response”Record<string, any>
The raw response object
string
The dot-notation path to resolve
Returns
Section titled “Returns”unknown
The resolved value, or undefined if any segment is missing
Inherited from
Section titled “Inherited from”AbstractDotPathResponseStrategy.resolve
resolveFrom()
Section titled “resolveFrom()”
protectedresolveFrom(response,options,currentPage,perPage?):number|undefined
Defined in: src/lib/strategies/abstract-dot-path-response.strategy.ts:90
Resolve the “from” index value
If options.from resolves to a value in the response, use it.
Otherwise compute (currentPage - 1) * perPage + 1 when both are known.
Parameters
Section titled “Parameters”response
Section titled “response”Record<string, any>
The raw response object
options
Section titled “options”The response key name configuration
currentPage
Section titled “currentPage”number
The current page number
perPage?
Section titled “perPage?”number
The number of items per page
Returns
Section titled “Returns”number | undefined
The “from” index, or undefined when neither path nor inputs suffice
Inherited from
Section titled “Inherited from”AbstractDotPathResponseStrategy.resolveFrom
resolveTo()
Section titled “resolveTo()”
protectedresolveTo(response,options,currentPage,perPage?,total?):number|undefined
Defined in: src/lib/strategies/abstract-dot-path-response.strategy.ts:119
Resolve the “to” index value
If options.to resolves to a value in the response, use it.
Otherwise compute Math.min(currentPage * perPage, total) when all
three are known.
Parameters
Section titled “Parameters”response
Section titled “response”Record<string, any>
The raw response object
options
Section titled “options”The response key name configuration
currentPage
Section titled “currentPage”number
The current page number
perPage?
Section titled “perPage?”number
The number of items per page
total?
Section titled “total?”number
The total number of items
Returns
Section titled “Returns”number | undefined
The “to” index, or undefined when neither path nor inputs suffice
Inherited from
Section titled “Inherited from”AbstractDotPathResponseStrategy.resolveTo