SpatieResponseStrategy
ArchivedThese are the docs for ng-qubee 3.8. Read the 4.0 docs for @qubeejs/angular.
Defined in: src/lib/strategies/spatie-response.strategy.ts:27
Response strategy for the Spatie Query Builder driver
Parses flat Laravel-style pagination responses (Spatie’s Query Builder is built on Laravel’s pagination):
{ "data": [...], "current_page": 1, "total": 100, "per_page": 15, "from": 1, "to": 15, ...}The traversal algorithm (flat response[options.X] lookups) is
inherited from AbstractFlatResponseStrategy; this class exists so
DriverEnum.SPATIE resolves to a distinct identity at the DI layer
even though the parsing logic is shared with the plain Laravel driver.
https://spatie.be/docs/laravel-query-builder
Extends
Section titled “Extends”AbstractFlatResponseStrategy
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpatieResponseStrategy():
SpatieResponseStrategy
Returns
Section titled “Returns”SpatieResponseStrategy
Inherited from
Section titled “Inherited from”AbstractFlatResponseStrategy.constructor
Methods
Section titled “Methods”paginate()
Section titled “paginate()”paginate<
T>(response,options):PaginatedCollection<T>
Defined in: src/lib/strategies/abstract-flat-response.strategy.ts:35
Parse a flat-envelope pagination 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 object
options
Section titled “options”The response key name configuration
Returns
Section titled “Returns”A typed PaginatedCollection instance
Inherited from
Section titled “Inherited from”AbstractFlatResponseStrategy.paginate