property RateLimitOptions.keyGenerator

Key generator function. Defaults to defaultRateLimitKey, which prefers the authenticated principal, then the client IP published by ipSecurityMiddleware, then IRequest.ip, and only then 'anonymous'.

Supply your own when none of those identify a caller in your deployment — an 'anonymous' key makes the limiter a single GLOBAL counter (see the note on defaultRateLimitKey).

Type

(ctx: IRequestContext) => string

Usage

import { type RateLimitOptions } from "auth-plugin/src/index.ts";