RedisRateLimiterOptions
Defined in: src/redis.ts:145
Extends
Section titled “Extends”Properties
Section titled “Properties”client
Section titled “client”client:
RedisClient
Defined in: src/redis.ts:30
Inherited from
Section titled “Inherited from”key:
string
Defined in: src/redis.ts:147
Shared limit identity: every instance using the same key (and prefix) shares one budget.
permitLimit
Section titled “permitLimit”permitLimit:
number
Defined in: src/redis.ts:149
Permits granted per window.
prefix?
Section titled “prefix?”
optionalprefix?:string
Defined in: src/redis.ts:32
Prepended to every key. Default 'rp:'.
Inherited from
Section titled “Inherited from”segmentsPerWindow?
Section titled “segmentsPerWindow?”
optionalsegmentsPerWindow?:number
Defined in: src/redis.ts:152
Buckets the window slides by; 1 = fixed window aligned to the epoch. Default 10.
window
Section titled “window”window:
Duration
Defined in: src/redis.ts:150