Skip to content

API reference / @backpack/aws-lambda / rest / QueryParameters

Interface: QueryParameters

Methods

get()

ts
get<TOptions>(name, options?): InferResult<string, TOptions, false>;

Retrieves one or more query parameters.

Type Parameters

Type Parameter
TOptions extends MultiOptions

Parameters

ParameterTypeDescription
namestringThe name of the query parameter.
options?TOptionsAdditional options.

Returns

InferResult<string, TOptions, false>

Throws

RequestValidationError


getQueryParameter()

ts
getQueryParameter<TOptions>(name, options?): InferResult<string, TOptions, false>;

To be removed in 1.0.

Type Parameters

Type Parameter
TOptions extends MultiOptions

Parameters

ParameterType
namestring
options?TOptions

Returns

InferResult<string, TOptions, false>

Deprecated

since version 0.5, please use QueryParameters.get instead.