How jacktubby/rate-guard works
Rate Guard is Express middleware that resolves a request key, checks it with a configured rate-limit algorithm and store, then either calls Express’s next handler or returns a 429 response with rate-limit headers. The factory selects Token Bucket or Fixed Window and memory or Redis storage; the store adapter supplies shared state operations. Redis is an optional external backend. The cleanup class exists in the tree but is not wired into the documented middleware workflow. Edges reflect the shown calls and README-described behavior; unsampled integrations are not inferred.
Main entry points: index.ts Rate Guard Middleware · limiter.ts Limiter Factory · rate-limit-store.ts Store Adapter · bucket.ts Token Bucket
Components 12
Middleware
- Rate Guard Middleware
src/index.ts - Request Key Resolver
src/helpers/entry-helpers.ts - Error Types
src/errors/errors.ts
Limit Algorithms
- Limiter Factory
src/limiter.ts - Token Bucket
src/limiters/bucket.ts - Fixed Window
src/limiters/fixed-window.ts
State Storage
- Store Adapter
src/store/rate-limit-store.ts - Memory Store
src/store/memory.ts - Redis Store
src/store/redis.ts
Other components
- Express Request
- Redis Service
- Next Handler or 429
Connections 18
- Express Request → Rate Guard Middleware: invokes
README.md - Rate Guard Middleware → Request Key Resolver: resolves key
src/index.ts - Request Key Resolver → Error Types: throws
src/helpers/entry-helpers.ts - Rate Guard Middleware → Error Types: throws validation error
src/index.ts - Rate Guard Middleware → Limiter Factory: creates limiter
src/index.ts - Limiter Factory → Memory Store: constructs
src/limiter.ts - Limiter Factory → Redis Store: constructs
src/limiter.ts - Limiter Factory → Token Bucket: selects
src/limiter.ts - Limiter Factory → Fixed Window: selects
src/limiter.ts - Limiter Factory → Store Adapter: wraps store
src/limiter.ts - Rate Guard Middleware → Token Bucket: checks limit
src/index.ts - Rate Guard Middleware → Fixed Window: checks limit
src/index.ts - Token Bucket → Store Adapter: reads and saves
src/limiters/bucket.ts - Fixed Window → Store Adapter: reads and saves
src/limiters/fixed-window.ts - Store Adapter → Memory Store: delegates state
src/store/rate-limit-store.ts - Store Adapter → Redis Store: delegates state
src/store/rate-limit-store.ts - Redis Store → Redis Service: gets and sets
src/store/redis.ts - Rate Guard Middleware → Next Handler or 429: continues or responds
src/index.ts