node-webserver
    Preparing search index...

    Type Alias Options

    type Options = {
        headers?: "include" | "remove";
        key?: (event: RequestEvent) => string;
        max: number;
        message?: string | Record<string, any>;
        onRateLimit?: (
            event: RequestEvent,
            info: { current: number; key: string; max: number },
        ) => void;
        statusCode?: number;
        store?: RateLimitStore;
        windowMs?: number;
    }
    Index

    Properties

    headers? key? max message? onRateLimit? statusCode? store? windowMs?

    Properties

    headers?: "include" | "remove"

    Whether to add rate limit headers

    'include'
    key?: (event: RequestEvent) => string

    Function to generate key for rate limiting

    IP address
    max: number

    Max number of requests per window

    message?: string | Record<string, any>

    Custom error message (string or JSON)

    "Too many requests, please try again later."
    onRateLimit?: (
        event: RequestEvent,
        info: { current: number; key: string; max: number },
    ) => void

    Called when rate limit is hit

    statusCode?: number

    HTTP status code to return

    429
    store?: RateLimitStore

    Storage backend

    MemoryStore
    windowMs?: number

    Window duration in milliseconds

    60_000 (1 minute)

    Settings

    Member Visibility

    On This Page

    Properties