Skip to main content
Version: 3.4.0

NestjsRequestStrategy

Defined in: src/lib/strategies/nestjs-request.strategy.ts:22

Request strategy for the NestJS (nestjs-paginate) driver

Generates URIs in the NestJS paginate format:

  • Simple filters: filter.field=value
  • Operator filters: filter.field=$operator:value
  • Sorts: sortBy=field1:DESC,field2:ASC
  • Select: select=col1,col2
  • Search: search=term
  • Pagination: limit=N&page=N

See​

https://github.com/ppetzold/nestjs-paginate

Extends​

  • AbstractRequestStrategy

Constructors​

Constructor​

new NestjsRequestStrategy(): NestjsRequestStrategy

Returns​

NestjsRequestStrategy

Inherited from​

AbstractRequestStrategy.constructor

Properties​

capabilities​

readonly capabilities: IStrategyCapabilities

Defined in: src/lib/strategies/nestjs-request.strategy.ts:28

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

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/nestjs-request.strategy.ts:63

Emit NestJS-format query-string segments in canonical order: filters → operator filters → sortBy → select → search → limit → page

Parameters​

state​

IQueryBuilderState

The current query builder state

options​

QueryBuilderOptions

The query parameter key name configuration

Returns​

string[]

Ordered query-string fragments

Overrides​

AbstractRequestStrategy.parts

validateLimit()​

validateLimit(limit): void

Defined in: src/lib/strategies/nestjs-request.strategy.ts:47

Validate that the given limit is accepted by nestjs-paginate

Accepts any integer >= 1 as a page size, plus -1 which nestjs-paginate interprets as "fetch all items" (server must opt-in via maxLimit: -1).

Parameters​

limit​

number

The limit value to validate

Returns​

void

Throws​

If the value is not an integer, or is 0, or is a negative number other than -1

Overrides​

AbstractRequestStrategy.validateLimit