@curveball/kernel/dist/context.d.ts

Curveball is a framework writting in Typescript for Node.js

import WebSocket from 'ws';
import { Middleware } from './application.js';
import { HeadersInterface, HeadersObject } from './headers.js';
import Request from './request.js';
import Response from './response.js';
/**
 * The Context object encapsulates a single HTTP request.
 *
 * It has references to the internal request and response object.
 */
export declare class Context<ReqT = any, ResT = any> {
    /**
     * HTTP Request
     */
    request: Request<ReqT>;
    /**
     * HTTP Response
     */
    response: Response<ResT>;
    /**
     * State information.
     *
     * The state property can be used to store request-specific state
     * information. It's used to pass information between middlewares.
     *
     * For example, and authentication middleware might set a username
     * in this property for other middlewares to use.
     */
    state: {
        [s: string]: any;
    };
    constructor(req: Request<ReqT>, res: Response<ResT>);
    /**
     * The Request path.
     *
     * Shortcut for request.path
     */
    get path(): string;
    get absoluteUrl(): string;
    /**
     * HTTP method
     *
     * Shortcut for request.method
     */
    get method(): string;
    /**
     * This object contains parsed query string parameters.
     *
     * This is a shortcut for request.query
     */
    get query(): {
        [s: string]: string;
    };
    /**
     * accepts is used for negotation the Content-Type with a client.
     *
     * You can pass a content-type, or an array of content-types.
     * The Content-Types you provide are a list of types your application
     * supports.
     *
     * This function will then return the best possible type based on the Accept
     * header.
     *
     * If no compatible types are found, this function returns null.
     *
     * This is a shortcut to request.accepts()
     */
    accepts(...types: string[]): null | string;
    /**
     * HTTP status code.
     *
     * This is a shortcut for response.status
     */
    get status(): number;
    /**
     * Sets the HTTP response status code.
     *
     * This is a shortcut for response.status.
     */
    set status(value: number);
    /**
     * Sends an informational (1xx status code) response.
     *
     * This is a shortcut for response.sendInformational()
     */
    sendInformational(status: number, headers?: HeadersInterface | HeadersObject): Promise<void>;
    /**
     * Sends a HTTP/2 push.
     *
     * The passed middleware will be called with a new Context object specific
     * for pushes.
     *
     * This is a shortcut for response.push()
     */
    push(callback: Middleware): Promise<void>;
    /**
     * returns the ip address of the client that's trying to connect.
     *
     * If 'trustProxy' is set to true, it means the server is running behind a
     * proxy, and the X-Forwarded-For header should be parsed instead.
     *
     * If there was no real HTTP client, this method will return null.
     */
    ip(trustProxy?: boolean): null | string;
    redirect(address: string): void;
    redirect(status: number, address: string): void;
    /**
     * WebSocket object.
     *
     * If the current request is a websocket request, this proprerty will be set
     *
     * @see https://github.com/websockets/ws#simple-server
     */
    webSocket?: WebSocket;
}
/**
 * WsContext always has a 'webSocket' property defined.
 */
export type WsContext = Context & {
    /**
     * WebSocket object.
     *
     * If the current request is a websocket request, this proprerty will be set
     *
     * @see https://github.com/websockets/ws#simple-server
     */
    webSocket: WebSocket;
};