Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • TBody

Hierarchy

  • Request

Index

Constructors

constructor

  • new Request(_path: Readonly<string>, _body: Readonly<TBody>, routeMetadata: RouteMetadata, pathParameters?: ReadonlyMap<string, string>, queryStringParameters?: ReadonlyMap<string, string | string[]>, headers?: ReadonlyMap<string, string | string[]>): Request
  • Parameters

    • _path: Readonly<string>
    • _body: Readonly<TBody>
    • routeMetadata: RouteMetadata
    • Default value pathParameters: ReadonlyMap<string, string> = new Map()
    • Default value queryStringParameters: ReadonlyMap<string, string | string[]> = new Map()
    • Default value headers: ReadonlyMap<string, string | string[]> = new Map()

    Returns Request

Properties

Protected _body

_body: Readonly<TBody>

Protected _context

_context: Map<string, any> = new Map<string, any>()

Protected _header

_header: ReadonlyMap<string, string | string[]>

Protected _method

_method: Readonly<HttpMethods>

Protected _path

_path: Readonly<string>

Protected _pathParam

_pathParam: ReadonlyMap<string, string>

Protected _queryParam

_queryParam: ReadonlyMap<string, string | string[]>

Protected _routeMetadata

_routeMetadata: Readonly<RouteMetadata>

Accessors

body

body:

method

method:

path

path:

routeMetadata

routeMetadata:

Methods

addContext

  • addContext<TValue>(key: string, value: TValue): void
  • Type parameters

    • TValue

    Parameters

    • key: string
    • value: TValue

    Returns void

getContext

  • getContext<TValue>(key: string): TValue

getHeader

  • getHeader(key: string): string | string[] | undefined

getHeaderOrFail

  • getHeaderOrFail(key: string): string | string[]

getPathParameter

  • getPathParameter(key: string): string | undefined

getPathParameterOrFail

  • getPathParameterOrFail(key: string): string

getQueryStringParameter

  • getQueryStringParameter(key: string): string | string[] | undefined

getQueryStringParameterOrFail

  • getQueryStringParameterOrFail(key: string): string | string[]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc