Skip to content
qubeequbee
API/SpatieRequestStrategy

SpatieRequestStrategy

src/strategies/spatie-request.strategy.ts6 public methodsclass

Request strategy for the Spatie Query Builder driver

Generates URIs in the Spatie format:

  • Fields: fields[model]=col1,col2
  • Filters: filter[field]=value
  • Includes: include=model1,model2
  • Sorts: sort=-field1,field2 (- prefix = DESC)
  • Pagination: limit=N&page=N

Constructor

Section titled “Constructor”
new SpatieRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, sorts, includes, per-model fields — no operators, no flat select, no global search

Methods

Section titled “Methods”

assertResource()

Section titled “assertResource()”
assertResource(state: QueryBuilderState): void

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.

Parameter Type Description
state QueryBuilderState The current query builder state

baseUri()

Section titled “baseUri()”
baseUri(state: QueryBuilderState): string

Compute the base path (no query string)

Parameter Type Description
state QueryBuilderState The current query builder state

Returns — The base URI without the query separator (e.g. /users or https://api.example.com/users)

buildUri()

Section titled “buildUri()”
buildUri(state: QueryBuilderState, options: QueryBuilderOptions): string

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.

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration

Returns — The composed URI string

join()

Section titled “join()”
join(base: string, segments: string[]): string

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 ? + &.

Parameter Type Description
base string The base URI from _baseUri
segments string[] The query-string fragments from parts(...)

Returns — The full URI

parts()

Section titled “parts()”
parts(state: QueryBuilderState, options: QueryBuilderOptions): string[]

Emit Spatie-format query-string segments in canonical order: include → fields → filters → limit → page → sort

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration

Returns — Ordered query-string fragments

validateLimit()

Section titled “validateLimit()”
validateLimit(limit: number): void

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.

Parameter Type Description
limit number The limit value to validate