internal.GateRateLimitOptionsEffect RateLimiter.consume / makeWithRateLimiter options for a gate
(key optional — defaults to the gate hyperlink / tag id). Policy only; the
RateLimiter / RateLimiterStore services are presence-driven in Context.
models
Source src/Gate.ts:4831 lines
export type type RateLimitOptions = Omit<
{
readonly algorithm?:
| "fixed-window"
| "token-bucket"
| undefined
readonly onExceeded?:
| "delay"
| "fail"
| undefined
readonly window: Input
readonly limit: number
readonly key: string
readonly tokens?: number | undefined
},
"key"
> & {
readonly key?: internal.RateLimiterConsumeOptions["key"]
}
Effect RateLimiter.consume / makeWithRateLimiter options for a gate
(key optional — defaults to the gate hyperlink / tag id). Policy only; the
RateLimiter / RateLimiterStore services are presence-driven in Context.
RateLimitOptions = import internalinternal.type GateRateLimitOptions = Omit<
{
readonly algorithm?:
| "fixed-window"
| "token-bucket"
| undefined
readonly onExceeded?:
| "delay"
| "fail"
| undefined
readonly window: Input
readonly limit: number
readonly key: string
readonly tokens?: number | undefined
},
"key"
> & {
readonly key?: internal.RateLimiterConsumeOptions["key"]
}
Gate rateLimit config — Effect's
RateLimiterConsumeOptions
with
optional key (defaults to the gate name / hyperlink tag id).
GateRateLimitOptions;
Referenced by 4 symbols