Class ApiXUrlQueryParameter<T>

An class that defines an optional query parameter in a method.

Query parameters are included in the request URL as such: apix.example.com/entity/method?paramName=paramValue&param2=value2

In this example, there are 2 parameters, paramName and param2, and each has a value of paramValue and value2, respectively.

Example

const queryParameters = [
  // input is paramName, so it's expected to be `/entity/method?paramName=some_value`
  new ApiXUrlQueryParameter('paramName', someValidator, someProcessor, true),
  // input is 'ANOTHER_PARAM', so it's expected to be `/entity/method?ANOTHER_PARAM=some_value`
  // use someProcessor to transform the name into something like anotherParam
  new ApiXUrlQueryParameter('ANOTHER_PARAM', someValidator, someProcessor)
]

See

ApiXMethod#queryParameters ApiXUrlQueryParameterValidator ApiXUrlQueryParameterProcessor

Type Parameters

Index

Constructors

constructor

new ApiXUrlQueryParameter<T>(name, validator, processor, isRequired?): ApiXUrlQueryParameter<T>
An optional query parameter.
Type Parameters
- T
Parameters
- name: string
  The name of the parameter to define.
- validator: ApiXUrlQueryParameterValidator
  The object that validates the value of the parameter, if present.
- processor: ApiXUrlQueryParameterProcessor<T>
  The object that processes the parameter and its value, if present.
- isRequired: boolean = false
Returns ApiXUrlQueryParameter<T>
- Defined in src/apixlib/common/methods/ApiXUrlQueryParameter.ts:60

Accessors

name

get name(): string
The name of URL query parameter.

Returns string
- Defined in src/apixlib/common/methods/ApiXUrlQueryParameter.ts:74

processor

get processor(): ApiXUrlQueryParameterProcessor<T>
A processor that will transform a parameter into its most optimal form to be used by a method request handler. For example, a parameter param=value1,value2,value3 can be transformed so that the value is converted into a ReadonlyArray<string> or a ReadonlySet<string>.

Returns ApiXUrlQueryParameterProcessor<T>
- Defined in src/apixlib/common/methods/ApiXUrlQueryParameter.ts:91

validator

get validator(): ApiXUrlQueryParameterValidator
The validator that determines whether the value of the parameter is valid.

Returns ApiXUrlQueryParameterValidator
- Defined in src/apixlib/common/methods/ApiXUrlQueryParameter.ts:81

Methods

get

get(req): undefined | [string, T]
A method that validates and processes a parameter into its final form.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  The express request that contains the query parameters.
Returns undefined | [string, T]
The processed key value pair or undefined if missing and not required.

Throws
MissingRequiredParameterError if the parameter is required but missing.

Throws
InvalidParameterError if the parameter validation fails.
- Defined in src/apixlib/common/methods/ApiXUrlQueryParameter.ts:102

Class ApiXUrlQueryParameter<T>

Example

See

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ApiXUrlQueryParameter<T>

Accessors

name

Returns string

processor

Returns ApiXUrlQueryParameterProcessor<T>

validator

Returns ApiXUrlQueryParameterValidator

Methods

get

Parameters

Returns undefined | [string, T]

Throws

Throws

Settings

On This Page