Stone.js API
    Preparing search index...

    Options for the @RateLimit activation.

    interface RateLimitDecoratorOptions {
        default?: string;
        global?: RateLimitRule;
        headers?: boolean;
        limiters?: LimiterConfig[];
        trustedAddressHeaders?: string[];
    }

    Hierarchy (View Summary)

    Index
    default?: string

    The limiter used when a rule names none. Defaults to memory.

    global?: RateLimitRule

    A rule applied to every route that declares none.

    Undeclared by default: a limit nobody asked for is a limit nobody sized, and the first thing it breaks is a legitimate burst.

    headers?: boolean

    Headers named after the caller's remaining budget, when the response can carry them.

    Standard by default (RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, and Retry-After on a refusal). Set false to say nothing: a public API may prefer not to publish the shape of its budget.

    limiters?: LimiterConfig[]

    The limiters this application configures.

    trustedAddressHeaders?: string[]

    Which request headers may carry the caller's real address, in order of preference.

    Empty by default, and that default matters: a forwarded header is client-spoofable unless a proxy you trust overwrites it, so reading one by default would hand every caller an unlimited supply of identities. Name the header your own edge guarantees.