Skip to content
qubeequbee
API/SpringRequestStrategy

SpringRequestStrategy

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

Request strategy for the Spring Data REST driver

Generates URIs in Spring Data REST’s pagination format:

  • Sorts: sort=field,asc&sort=other,desc (repeatable param, one per rule)
  • Pagination: page=N&size=N — page is 0-indexed on the wire; the library state stays 1-indexed and the strategy subtracts 1 at emission time

Spring Data REST defines no standard query parameter convention for filtering, field selection, includes, or global search — those are implemented server-side via custom query methods or Specifications. The corresponding fluent methods (addFilter, addFilterOperator, addSelect, addFields, addIncludes, setSearch) throw the matching Unsupported*Error on this driver.

Constructor

Section titled “Constructor”
new SpringRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Sorts only — Spring Data REST has no standard wire convention for filters, operator filters, per-model fields, flat select, includes, or 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 Spring-format query-string segments in canonical order: sort → page → size

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration (used for page and sort, whose defaults match the wire format; the size key is fixed by the server)

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