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

Interface: Request

Various utilities relating to a HTTP Request

Methods

getBody()

getBody(): Body;

Retrieves the body of the HTTP request.

Returns

Body

---

getHeader()

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

Retrieves one or more request headers.

Type Parameters

Type Parameter
TOptions extends MultiOptions

Parameters

Parameter	Type	Description
name	string	The name of the request header.
options?	TOptions	Additional options.

Returns

InferResult<string, TOptions, false>

Throws

RequestValidationError

---

getPathParameter()

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

Retrieves one or more path parameters.

Type Parameters

Type Parameter
TOptions extends Options

Parameters

Parameter	Type	Description
name	string	The name of the path parameter.
options?	TOptions	Additional options.

Returns

InferResult<string, TOptions, true>

Throws

RequestValidationError

---

getQueryParameter()

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

Retrieves one or more query parameters.

Type Parameters

Type Parameter
TOptions extends MultiOptions

Parameters

Parameter	Type	Description
name	string	The name of the query parameter.
options?	TOptions	Additional options.

Returns

InferResult<string, TOptions, false>

Throws

RequestValidationError