Skip to content

Quick Start

Installation

Choose the package for your framework:

Terminal window
# For Hono
npm install @jfungus/ratelimit-hono
# For Express
npm install @jfungus/ratelimit-express
# For H3/Nitro
npm install @jfungus/ratelimit-h3
# For Nuxt
npm install @jfungus/ratelimit-nuxt

Package Guides

Each package has detailed documentation:

Configuration Options

All packages share these common options:

OptionTypeDefaultDescription
limitnumber100Maximum requests per window
windowMsnumber60000Window duration in milliseconds
algorithm'fixed-window' | 'sliding-window''sliding-window'Rate limiting algorithm
storeRateLimitStoreMemoryStoreStorage backend
keyGeneratorfunctionIP-basedFunction to generate client key
skipfunction-Function to skip rate limiting
handlerfunction429 responseCustom rate limit response
dryRunbooleanfalseLog but don’t block

Next Steps