Skip to content
API/AbstractRequestStrategy

AbstractRequestStrategy

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

Base class for request strategies

Concentrates the glue every concrete strategy used to copy: the resource-required guard, the ?/& URL composition, and the default positive-integer validateLimit. Concrete strategies override only the parts that differ — the per-driver wire format goes into a single protected parts(state, options): string[] method that returns the ordered query-string segments the base then joins.

Drivers that need a non-default validateLimit (e.g. NestJS, which accepts -1 as a fetch-all sentinel) override that method directly.

new AbstractRequestStrategy()
Property Type Description
capabilities StrategyCapabilities Capability declaration for this driver Concrete strategies must provide a static, immutable capability map so NgQubeeService._assertCapability(...) can read it.
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(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(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(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(state: QueryBuilderState, options: QueryBuilderOptions): string[]

Per-driver query-string segments, in emission order

Each entry is one key=value (or key=v1&key=v2 for compound params like PostgREST’s BTW). Empty arrays are valid and produce a URI containing only the resource path.

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration

Returns — Ordered list of query-string fragments

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