API reference / @backpack/aws-lambda / rest / Headers
Interface: Headers
Methods
get()
ts
get<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
getHeader()
ts
getHeader<TOptions>(name, options?): InferResult<string, TOptions, false>;To be removed in 1.0.
Type Parameters
| Type Parameter |
|---|
TOptions extends MultiOptions |
Parameters
| Parameter | Type |
|---|---|
name | string |
options? | TOptions |
Returns
InferResult<string, TOptions, false>
Deprecated
since version 0.5, please use Headers.get instead.