API/FeathersRequestStrategy

FeathersRequestStrategy

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

Request strategy for the FeathersJS driver

Generates URIs in Feathers’ common database adapter query syntax:

Filters: field=value (exact match); multi-value folds to $in (field[$in][0]=v1&field[$in][1]=v2)
Operator filters: field[$op]=value (translated from FilterOperatorEnum — BTW→$gte+$lte pair, NOT→$ne/$nin)
Sorts: $sort[field]=1 (ASC) / $sort[field]=-1 (DESC)
Flat field selection: $select[0]=col1&$select[1]=col2
Pagination (offset-based): $limit=N&$skip=M with skip = (page - 1) × limit

The dollar-prefixed query keys ($limit, $skip, $sort, $select) are fixed by the Feathers adapter-commons parser and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place.

Feathers’ core adapter syntax has no relation includes, no per-model field selection, and no global search — the corresponding fluent methods throw the matching Unsupported*Error. CONTAINS / ILIKE / SW (LIKE-style matching is adapter-specific, not core), NULL (no null-check operator on the wire), and the PostgREST-native full-text operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

new FeathersRequestStrategy()

Properties

Property	Type	Description
`capabilities`	`StrategyCapabilities`	Filters, operator filters, sorts, flat field selection (`select`) — no per-model fields, no includes, no global search, no embedded resources

Methods

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

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

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

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

parts(state: QueryBuilderState, _options: QueryBuilderOptions): string[]

Emit Feathers-format query-string segments in canonical order: filters → operator filters → $sort → $select → $limit → $skip

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state
`_options`	`QueryBuilderOptions`	The query parameter key name configuration (unused; Feathers’ system keys are fixed by the server)

Returns — Ordered query-string fragments

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