Skip to content
qubeequbee
API/NestjsxCrudRequestStrategy

NestjsxCrudRequestStrategy

src/strategies/nestjsx-crud-request.strategy.ts6 public methodsclass

Request strategy for the @nestjsx/crud driver

Generates URIs in @nestjsx/crud’s pipe-delimited query format:

  • Filters: filter=field||$eq||value (repeatable; multi-value collapses to filter=field||$in||v1,v2)
  • Operator filters: filter=field||$op||value (translated from FilterOperatorEnum — CONTAINS→$cont, ILIKE→$contL, SW→$starts, BTW→$between, NOT→$ne/$notin, NULL→$isnull/$notnull with no value segment)
  • Joins: join=relation (repeatable, from addIncludes)
  • Field selection (flat): fields=col1,col2 (from addSelect)
  • Sorts: sort=field,ASC (repeatable, uppercase direction)
  • Pagination (page-based): page=N&limit=N

The JSON-shaped s={...} search parameter is intentionally out of scope: it is not a plain search term, so setSearch throws UnsupportedSearchError on this driver. PostgREST-native full-text search operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

Section titled “Constructor”
new NestjsxCrudRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, joins (includes), flat field selection (select), sorts — no per-model fields, no global search (the s parameter is JSON-shaped, not a plain term)

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)

Exactly one slash joins the two: trailing slashes on the base URL and leading slashes on the resource are dropped, so /projects/42/tasks never becomes the protocol-relative //projects/42/tasks. A trailing slash on the resource is kept, for backends whose routes end in one. Nothing is encoded.

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.

parts(...) receives the state with filter values, operator-filter values and the search term already percent-encoded (see encodeValues), so no concrete strategy encodes on its own and none can forget to.

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 @nestjsx/crud-format query-string segments in canonical order: fields → filters → operator filters → join → sort → limit → page

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration (used for page / limit, whose defaults match the wire format; the fields / filter / join / sort keys are 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