cassava/dist/RouterResponse.d.ts

AWS API Gateway Router

import * as cookie from "cookie";
/**
 * An HTTP response that will be processed into a proper AWS API Gateway
 * ProxyResponse by the Router.
 */
export interface RouterResponse {
    /**
     * The HTTP status code to respond with.  Defaults to 200.
     */
    statusCode?: number;
    /**
     * Optional headers to set on the response.
     */
    headers?: {
        [key: string]: string;
    };
    /**
     * Optional headers to set on the response but allowing multiple
     * values.
     */
    multiValueHeaders?: {
        [header: string]: string[];
    };
    /**
     * Optional cookies to set on the response.
     */
    cookies?: {
        [key: string]: string | RouterResponseCookie;
    };
    /**
     * The body of the response, which will be stringified unless
     * `headers["Content-Type"]` is specified and not `"application/json"`
     * and the body is already a string.
     */
    body: any;
}
export interface RouterResponseCookie {
    value: string;
    options?: cookie.CookieSerializeOptions;
}
export declare namespace RouterResponse {
    function getHeader(resp: RouterResponse, field: string): string | string[] | null;
    function setHeader(resp: RouterResponse, field: string, value: string): void;
}