Skip to main content
Version: next

SpatieResponseStrategy

Defined in: src/lib/strategies/spatie-response.strategy.ts:24

Response strategy for the Spatie Query Builder driver

Parses flat Laravel pagination responses:

{
  "data": [...],
  "current_page": 1,
  "total": 100,
  "per_page": 15,
  "from": 1,
  "to": 15,
  ...
}

See​

https://spatie.be/docs/laravel-query-builder

Implements​

Constructors​

Constructor​

new SpatieResponseStrategy(): SpatieResponseStrategy

Returns​

SpatieResponseStrategy

Methods​

paginate()​

paginate<T>(response, options): PaginatedCollection<T>

Defined in: src/lib/strategies/spatie-response.strategy.ts:34

Parse a flat Laravel pagination response into a PaginatedCollection

Type Parameters​

T​

T extends IPaginatedObject

Parameters​

response​

Record<string, any>

The raw API response object

options​

ResponseOptions

The response key name configuration

Returns​

PaginatedCollection<T>

A typed PaginatedCollection instance

Implementation of​

IResponseStrategy.paginate