tezx/middleware/cache-control.d.ts

TezX is a modern, ultra-lightweight, and high-performance JavaScript framework built specifically for Bun. It provides a minimal yet powerful API, seamless environment management, and a high-concurrency HTTP engine for building fast, scalable web applicat

import { Context } from "../index.js";
import { HttpBaseResponse, Middleware } from "../types/index.js";
export interface CacheRule {
    /** 🎯 Condition to determine if this rule applies */
    condition: (ctx: Context) => boolean;
    /** ⏳ Max age (seconds) */
    maxAge: number;
    /** 🌐 Cache scope */
    scope: "public" | "private";
    /** 🏷️ Vary header list */
    vary?: string[];
}
export interface CacheSettings extends Pick<CacheRule, "maxAge" | "scope" | "vary"> {
}
export interface CacheOptions {
    /** 🧱 Default cache behavior */
    defaultSettings: CacheSettings;
    /** 🔧 Optional rules for dynamic caching */
    rules?: readonly CacheRule[];
    /** 📝 Logging hook */
    /** 🚨 Error handler */
    onError?: (error: Error, ctx: Context) => HttpBaseResponse;
}
/**
 * ⚡ Ultra-lightweight, low-level cache control middleware.
 * Adds 'Cache-Control', 'Expires', and optional 'Vary' headers.
 */
export declare const cacheControl: <T extends Record<string, any> = {}, Path extends string = any>(opts: CacheOptions) => Middleware<T, Path>;
export default cacheControl;