LaravelRequestStrategy
Defined in: src/lib/strategies/laravel-request.strategy.ts:14
Request strategy for the Laravel (pagination-only) driver
Generates simple pagination URIs:
/{resource}?limit=N&page=N
Filters, sorts, fields, includes, search, and select in state are ignored.
Extends
AbstractRequestStrategy
Constructors
Constructor
new LaravelRequestStrategy():
LaravelRequestStrategy
Returns
LaravelRequestStrategy
Inherited from
AbstractRequestStrategy.constructor
Properties
capabilities
readonlycapabilities:IStrategyCapabilities
Defined in: src/lib/strategies/laravel-request.strategy.ts:19
Pagination-only driver — no filtering, sorting, or column selection
Overrides
AbstractRequestStrategy.capabilities
Methods
assertResource()
protectedassertResource(state):void
Defined in: src/lib/strategies/abstract-request.strategy.ts:89
Throw if the resource is not set on the state
Centralises the message that was previously copy-pasted across four of the five concrete strategies.
Parameters
state
The current query builder state
Returns
void
Throws
Error if state.resource is empty
Inherited from
AbstractRequestStrategy.assertResource
baseUri()
protectedbaseUri(state):string
Defined in: src/lib/strategies/abstract-request.strategy.ts:101
Compute the base path (no query string)
Parameters
state
The current query builder state
Returns
string
The base URI without the query separator (e.g. /users or https://api.example.com/users)
Inherited from
AbstractRequestStrategy.baseUri
buildUri()
buildUri(
state,options):string
Defined in: src/lib/strategies/abstract-request.strategy.ts:42
Compose the full request URI from the given state
Template method: validates the resource, computes the base path,
delegates the per-driver query-string segments to parts(...), and
joins them with the conventional ?/& separators.
Parameters
state
The current query builder state
options
QueryBuilderOptions
The query parameter key name configuration
Returns
string
The composed URI string
Throws
Error if the resource is not set
Inherited from
AbstractRequestStrategy.buildUri
join()
protectedjoin(base,segments):string
Defined in: src/lib/strategies/abstract-request.strategy.ts:115
Glue the base URI and the per-driver query-string segments
Returns the bare base when no segments were emitted (e.g. PostgREST
in RANGE mode with no filters), otherwise joins with ? + &.
Parameters
base
string
The base URI from _baseUri
segments
string[]
The query-string fragments from parts(...)
Returns
string
The full URI
Inherited from
AbstractRequestStrategy.join
parts()
protectedparts(state,options):string[]
Defined in: src/lib/strategies/laravel-request.strategy.ts:36
Emit only the pagination params; filters/sorts/etc. are ignored
Parameters
state
The current query builder state
options
QueryBuilderOptions
The query parameter key name configuration
Returns
string[]
The two pagination query-string fragments
Overrides
AbstractRequestStrategy.parts
validateLimit()
validateLimit(
limit):void
Defined in: src/lib/strategies/abstract-request.strategy.ts:59
Validate that a limit value is acceptable for this driver
Default policy: positive integer. Drivers that recognise a sentinel
(NestJS treats -1 as "fetch all") override this method.
Parameters
limit
number
The limit value to validate
Returns
void
Throws
If the value is not a positive integer
Inherited from
AbstractRequestStrategy.validateLimit