Skip to content

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

Interface: PathParameters

Methods

get()

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

Retrieves one or more path parameters.

Type Parameters

Type Parameter
TOptions extends Options

Parameters

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

Returns

InferResult<string, TOptions, true>

Throws

RequestValidationError


getPathParameter()

ts
getPathParameter<TOptions>(name, options?): InferResult<string, TOptions, true>;

To be removed in 1.0.

Type Parameters

Type Parameter
TOptions extends Options

Parameters

ParameterType
namestring
options?TOptions

Returns

InferResult<string, TOptions, true>

Deprecated

since version 0.5, please use PathParameters.get instead.