AbstractRequestStrategy
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.
Constructor
Section titled “Constructor”new AbstractRequestStrategy()Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
capabilities |
StrategyCapabilities |
Capability declaration for this driver Concrete strategies must provide a static, immutable capability map so QueryBuilder can gate its feature methods on it. |
Methods
Section titled “Methods”assertResource()
Section titled “assertResource()”assertResource(state: QueryBuilderState): voidThrow 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): stringCompute 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): stringCompose 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[]): stringGlue 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[]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()
Section titled “validateLimit()”validateLimit(limit: number): voidValidate 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 |