Skip to main content
Version: next

JsonServerRequestStrategy

Defined in: src/lib/strategies/json-server-request.strategy.ts:38

Request strategy for the json-server driver

Generates URIs in json-server's query format — the de-facto standard mock REST API for prototyping:

  • Filters: field=value (exact, no operator); multi-value folds to the in list (field:in=v1,v2)
  • Operator filters: colon syntax field:op=value — see the mapping on _formatOperatorSegments
  • Sorts: _sort=-views,title (CSV, - prefix = DESC)
  • Search: q=term (full-text search)
  • Pagination: _page=N&_per_page=M

The underscore-prefixed system params (_page, _per_page, _sort) and the q search key are fixed by the server and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place.

json-server has no per-model field selection, no relation includes, no column projection — the corresponding fluent methods throw the matching Unsupported*Error. ILIKE (no case-insensitive variant), NULL (no null check), and the PostgREST-native full-text operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

See​

https://github.com/typicode/json-server

Extends​

  • AbstractRequestStrategy

Constructors​

Constructor​

new JsonServerRequestStrategy(): JsonServerRequestStrategy

Returns​

JsonServerRequestStrategy

Inherited from​

AbstractRequestStrategy.constructor

Properties​

capabilities​

readonly capabilities: IStrategyCapabilities

Defined in: src/lib/strategies/json-server-request.strategy.ts:44

Filters, operator filters, sorts, global search — no per-model fields, no includes, no flat select, no embedded resources

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/json-server-request.strategy.ts:76

Emit json-server-format query-string segments in canonical order: filters → operator filters → _sort → q → _page → _per_page

Parameters​

state​

IQueryBuilderState

The current query builder state

_options​

QueryBuilderOptions

The query parameter key name configuration (unused; json-server's system keys are 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