Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Request

Responsible for provide a set of methods to manipulate a http request

Hierarchy

  • Request

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Request(incoming: IncomingMessage): Request

  • Instanciates a new Request

    Parameters

    • incoming: IncomingMessage

      instance of http incoming request

    Returns Request

Properties

Private _incoming

_incoming: IncomingMessage

Http incoming request

body

body: any

Parsed http request body, empty if method does not support body.

params

params: any

Parsed http params.

queries

queries: any

Parsed http queries.

Accessors

headers

  • get headers(): Dict<string | string[]>

  • Returns http request headers.

    Returns Dict<string | string[]>

Methods

bodyAs

  • bodyAs<T>(BodyType: Newable<T>): Promise<T>

  • Returns validated http request body.

    Type parameters

    • T

    Parameters

    • BodyType: Newable<T>

      expected body data type.

    Returns Promise<T>

parseBody

  • parseBody(): Promise<any>

  • Reads http request body from buffer and returns it's contents as a json object.

    Returns Promise<any>

parseQueries

  • parseQueries(): any

  • Reads http request queries and returns it's contents as a json object.

    Returns any

queriesAs

  • queriesAs<T>(QueryType: Newable<T>): Promise<T>

  • Returns validated http request queries.

    Type parameters

    • T

    Parameters

    • QueryType: Newable<T>

      expected query data type.

    Returns Promise<T>

Generated using TypeDoc