Interface HttpRequest

An HttpRequest is stack allocated and only accessible during the callback invocation.

Hierarchy

HttpRequest

Index

Methods

Methods

forEach

forEach(cb: (key: string, value: string) => void): void

- Defined in index.d.ts:197
Loops over all headers.

Parameters
- cb: (key: string, value: string) => void
  - - (key: string, value: string): void
    - Parameters
      - key: string
      - value: string
      Returns void
Returns void

getHeader

getHeader(lowerCaseKey: RecognizedString): string

- Defined in index.d.ts:187
Returns the lowercased header value or empty string.

Parameters
- lowerCaseKey: RecognizedString
Returns string

getMethod

getMethod(): string

- Defined in index.d.ts:193
Returns the HTTP method, useful for "any" routes.

Returns string

getParameter

getParameter(index: number): string

- Defined in index.d.ts:189
Returns the parsed parameter at index. Corresponds to route.

Parameters
- index: number
Returns string

getQuery

getQuery(): string

- Defined in index.d.ts:195
Returns the part of URL after ? sign or empty string.

Returns string

getUrl

getUrl(): string

- Defined in index.d.ts:191
Returns the URL including initial /slash

Returns string

setYield

setYield(yield: boolean): HttpRequest

- Defined in index.d.ts:199
Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.

Parameters
- yield: boolean
Returns HttpRequest

Generated using TypeDoc