property RateLimitOptions.exclude
Since 0.5.0

Paths exempted from the limiter, matched against IRequest.path. A string is an EXACT match; a RegExp is tested against the path.

Omitted, this is DEFAULT_RATE_LIMIT_EXCLUDED_PATHS — the six operational paths the framework's own plugins serve. That default exists because the limiter is documented as a global middleware and the CLI scaffolds Kubernetes probes pointing at /live and /ready: without it, an exhausted bucket answers the liveness probe 429 and the kubelet restarts a container whose only fault is that it is under load.

Pass [] to exempt nothing, which is the pre-0.5.0 behaviour.

Type

readonly PathPattern[]

Usage

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