Options
All
  • Public
  • Public/Protected
  • All
Menu

An HTTP request object.

export
class

Request

Hierarchy

  • Request

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Request(event: APIGatewayEvent): Request
  • Creates an instance of Request.

    memberof

    Request

    Parameters

    • event: APIGatewayEvent

    Returns Request

Properties

auth

auth: any

The decoded authorization JWT information.

type

{*}

memberof

Request

body

body: string | null

The body of the request.

type

{(string | null)}

memberof

Request

data

data: any

The Javascript representation of the request body.

type

{*}

memberof

Request

event

event: APIGatewayEvent

The underlying serverless event object.

type

{APIGatewayEvent}

memberof

Request

headers

headers: object

The request headers.

type

{{ [name: string]: string }}

memberof

Request

Type declaration

  • [name: string]: string

id

id: string

The request identifier.

type

{string}

memberof

Request

method

method: string

The method or verb requested.

type

{string}

memberof

Request

params

params: object | null

The path parameters.

type

{({ [name: string]: string } | null)}

memberof

Request

path

path: string

The path requested.

type

{string}

memberof

Request

query

query: object | null

The query parameters.

type

{({ [name: string]: string } | null)}

memberof

Request

Methods

Private parseBody

  • parseBody(): void
  • Parses the body of a request if the Content-Type header is application/json. If parsing fails, a Bad Request is thrown.

    throws

    {BadRequest}

    memberof

    Request

    Returns void

Generated using TypeDoc