Skip to main content
Version: next

SpringRequestStrategy

Defined in: src/lib/strategies/spring-request.strategy.ts:25

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.

See​

https://docs.spring.io/spring-data/rest/reference/paging-and-sorting.html

Extends​

  • AbstractRequestStrategy

Constructors​

Constructor​

new SpringRequestStrategy(): SpringRequestStrategy

Returns​

SpringRequestStrategy

Inherited from​

AbstractRequestStrategy.constructor

Properties​

capabilities​

readonly capabilities: IStrategyCapabilities

Defined in: src/lib/strategies/spring-request.strategy.ts:32

Sorts only — Spring Data REST has no standard wire convention for filters, operator filters, per-model fields, flat select, includes, or global search

Overrides​

AbstractRequestStrategy.capabilities

Methods​

assertResource()​

protected assertResource(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​

IQueryBuilderState

The current query builder state

Returns​

void

Throws​

Error if state.resource is empty

Inherited from​

AbstractRequestStrategy.assertResource

baseUri()​

protected baseUri(state): string

Defined in: src/lib/strategies/abstract-request.strategy.ts:101

Compute the base path (no query string)

Parameters​

state​

IQueryBuilderState

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​

IQueryBuilderState

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()​

protected join(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()​

protected parts(state, options): string[]

Defined in: src/lib/strategies/spring-request.strategy.ts:63

Emit Spring-format query-string segments in canonical order: sort → page → size

Parameters​

state​

IQueryBuilderState

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​

string[]

Ordered 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