tezx
Version:
TezX is a high-performance, lightweight JavaScript framework designed for speed, scalability, and flexibility. It enables efficient routing, middleware management, and static file serving with minimal configuration. Fully compatible with Node.js, Deno, an
216 lines (215 loc) • 8.48 kB
TypeScript
import { CookieOptions, HTTPMethod, PathType, ResponseHeaders } from "../types/index.js";
import { State } from "../utils/state.js";
import { Request as RequestParser } from "./request.js";
import { TezXServeOptions } from "./server.js";
export declare class Context<T extends Record<string, any> = {}, Path extends PathType = any> {
#private;
[key: string]: any;
rawRequest: Request;
/**
* Environment variables and configuration
* @type {object}
*/
env: Record<string, any> & T;
/**
* Parser for handling and manipulating HTTP headers
* @type {Headers}
*/
headers: Headers;
/**
* Request path without query parameters
* @type {string}
*/
readonly pathname: string;
/**
* Full request URL including protocol and query string
* @type {string}
*/
readonly url: string;
/**
* HTTP request method (GET, POST, PUT, DELETE, etc.)
* @type {HTTPMethod}
*/
readonly method: HTTPMethod;
/**
* Public state container for application data
* state storage for middleware and plugins
* @type {State}
*/
state: State;
protected readonly resBody?: BodyInit | null;
constructor(req: any, options: TezXServeOptions);
/**
* Appends or set a value to an existing header or creates a new one.
* @param key - Header name.
* @param value - Value to append.
* @default {append:false}
*/
header(key: string, value: string, options?: {
append?: true;
}): this;
header(key: string, value: string | string[], options?: {
append?: false;
}): this;
/**
* Cookie handling utility with get/set/delete operations
* @returns {{
* get: (name: string) => string | undefined,
* all: () => Record<string, string>,
* delete: (name: string, options?: CookieOptions) => void,
* set: (name: string, value: string, options?: CookieOptions) => void
* }} Cookie handling interface
*/
get cookies(): {
/**
* Get a specific cookie by name.
* @param {string} cookie - The name of the cookie to retrieve.
* @returns {string | undefined} - The cookie value or undefined if not found.
*/
get: (cookie: string) => string;
/**
* Get all cookies as an object.
* @returns {Record<string, string>} - An object containing all cookies.
*/
all: () => Record<string, string>;
/**
* Delete a cookie by setting its expiration to the past.
* @param {string} name - The name of the cookie to delete.
* @param {CookieOptions} [options] - Additional cookie options.
*/
delete: (name: string, options?: CookieOptions) => void;
/**
* Set a new cookie with the given name, value, and options.
* @param {string} name - The name of the cookie.
* @param {string} value - The value of the cookie.
* @param {CookieOptions} [options] - Additional options like expiration.
*/
set: (name: string, value: string, options?: CookieOptions) => void;
};
/**
* Sends a JSON response.
* @param body - The response data.
* @param status - (Optional) HTTP status code (default: 200).
* @param headers - (Optional) Additional response headers.
* @returns Response object with JSON data.
*/
json(body: object, status?: number, headers?: ResponseHeaders): Response;
json(body: object, headers?: ResponseHeaders): Response;
json(body: object, status?: number): Response;
/**
* Sends a response with any content type.
* Automatically determines content type if not provided.
* @param body - The response body.
* @param status - (Optional) HTTP status code.
* @param headers - (Optional) Additional response headers.
* @returns Response object.
*/
send(body: any, status?: number, headers?: ResponseHeaders): Response;
send(body: any, headers?: ResponseHeaders): Response;
send(body: any, status?: number): Response;
/**
* Sends an HTML response.
* @param strings - The HTML content as a string. Supports `both template literals` and plain string input..
* @param status - (Optional) HTTP status code (default: 200).
* @param headers - (Optional) Additional response headers.
* @returns Response object with HTML data.
*/
html(strings: readonly string[], ...values: any[]): Response;
html(strings: string, status?: number, headers?: ResponseHeaders): Response;
html(strings: string, headers?: ResponseHeaders): Response;
html(strings: string, status?: number): Response;
/**
* Sends a plain text response.
* @param data - The text content.
* @param status - (Optional) HTTP status code (default: 200).
* @param headers - (Optional) Additional response headers.
* @returns Response object with plain text data.
*/
text(data: string, status?: number, headers?: ResponseHeaders): Response;
text(data: string, headers?: ResponseHeaders): Response;
text(data: string, status?: number): Response;
/**
* Sends an XML response.
* @param data - The XML content.
* @param status - (Optional) HTTP status code (default: 200).
* @param headers - (Optional) Additional response headers.
* @returns Response object with XML data.
*/
xml(data: string, status?: number, headers?: ResponseHeaders): Response;
xml(data: string, headers?: ResponseHeaders): Response;
xml(data: string, status?: number): Response;
/**
* HTTP status code..
* @param status - number.
* @returns Response object with context all method.
*/
status: (status: number) => this;
set setStatus(status: number);
get getStatus(): number;
/**
* Redirects to a given URL.
* @param url - The target URL.
* @param status - (Optional) HTTP status code (default: 302).
* @returns Response object with redirect.
*/
redirect(url: string, status?: number): Response;
/**
* Handles file downloads.
* @param filePath - The path to the file.
* @param fileName - The name of the downloaded file.
* @returns Response object for file download.
*/
download(filePath: string, fileName: string): Promise<Response>;
/**
* Serves a file to the client.
* @param filePath - Absolute or relative path to the file.
* @param fileName - (Optional) The name of the send file.
* @param headers - (Optional) Additional headers.
* @returns Response object with the file stream.
*/
sendFile(filePath: string, fileName?: string, headers?: ResponseHeaders): Promise<Response>;
sendFile(filePath: string, headers?: ResponseHeaders): Promise<Response>;
sendFile(filePath: string, fileName?: string): Promise<Response>;
/**
* Getter that creates a standardized Request object from internal state
* @returns {Request} - Normalized request object combining:
* - Raw platform-specific request
* - Parsed headers
* - Route parameters
*
* @example
* // Get standardized request
* const request = ctx.req;
* // Access route params
* const id = request.params.get('id');
*/
get req(): RequestParser<Path>;
protected set params(params: Record<string, any>);
/**
* Set response body to be passed between middlewares or returned as final output.
*
* 🔄 Use-case:
* - Middleware or route handlers can set this value to share data.
* - If no explicit Response is returned (e.g., `ctx.json()` or `new Response()`),
* then this body will be auto-wrapped into a `Response` by the framework.
*
* ⚠️ Note:
* Always use `return next()` or an explicit return like `return ctx.json(...)`
* to ensure proper flow control and response resolution.
*
* @param body - The response content (string, object, etc).
*/
set body(body: any);
/**
* Get the current response body.
*
* 🧠 Use-case:
* - Allows middleware or route handler to access any pre-set data
* from earlier in the middleware chain.
* - Common for situations where response is deferred or centrally handled.
*
* @returns The currently stored response body.
*/
get body(): any;
protected get params(): Record<string, any>;
}