Interface HttpRequest

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

interface HttpRequest {
    forEach(cb): void;
    getCaseSensitiveMethod(): string;
    getHeader(lowerCaseKey): string;
    getMethod(): string;
    getParameter(index): string;
    getQuery(): string;
    getQuery(key): string;
    getUrl(): string;
    setYield(_yield): HttpRequest;
}

Methods

forEach getCaseSensitiveMethod getHeader getMethod getParameter getQuery getUrl setYield

Methods

forEach

  • forEach(cb): void

  • Loops over all headers.

    Parameters

    • cb: ((key, value) => void)
        • (key, value): void

        • Parameters

          • key: string
          • value: string

          Returns void

    Returns void

getCaseSensitiveMethod

  • getCaseSensitiveMethod(): string

  • Returns the HTTP method as-is.

    Returns string

getHeader

  • getHeader(lowerCaseKey): string

  • Returns the lowercased header value or empty string.

    Parameters

    Returns string

getMethod

  • getMethod(): string

  • Returns the lowercased HTTP method, useful for "any" routes.

    Returns string

getParameter

  • getParameter(index): string

  • Returns the parsed parameter at index. Corresponds to route. Can also take the name of the parameter.

    Parameters

    Returns string

getQuery

  • getQuery(): string

  • Returns the raw querystring (the part of URL after ? sign) or empty string.

    Returns string

  • getQuery(key): string

  • Returns a decoded query parameter value or undefined.

    Parameters

    • key: string

    Returns string

getUrl

  • getUrl(): string

  • Returns the URL including initial /slash

    Returns string

setYield

  • setYield(_yield): HttpRequest

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc