# sliding-window-rate-limiter > Sliding window rate limiter with Redis 3.2 backend Latest version **6.0.1** (published 2024-06-25) · MIT license · 0 weekly downloads ## Install ```sh npm install sliding-window-rate-limiter pnpm add sliding-window-rate-limiter yarn add sliding-window-rate-limiter bun add sliding-window-rate-limiter ``` ## Health **Score 45/100 (D)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 6.0.1 | | Published | 2024-06-25 | | First published | 2017-07-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=16.0.0 | | Dependencies | 1 | | Unpacked size | 41.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 16 | | Author | Piotr Roszatycki | | Keywords | limiter, rate, redis, rolling, sliding | ## Links - npm: https://www.npmjs.com/package/sliding-window-rate-limiter - Repository: https://github.com/dex4er/js-sliding-window-rate-limiter - Homepage: http://github.com/dex4er/js-sliding-window-rate-limiter - Issues: https://github.com/dex4er/js-sliding-window-rate-limiter/issues - npm.io page: https://npm.io/package/sliding-window-rate-limiter ## Dependencies (1) - [ioredis](https://npm.io/package/ioredis.md) ^5.4.1 ## Alternatives - [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads - [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads - [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads - [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads - [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads ## Recent versions - 6.0.1 (latest) — 2024-06-25 - 6.0.0 — 2024-06-25 - 5.0.0 — 2020-10-05 - 4.1.1 — 2019-10-08 - 4.1.0 — 2019-08-06 - 4.0.0 — 2019-07-11 - 3.0.0 — 2019-06-25 - 2.1.2 — 2019-06-04 - 2.1.1 — 2019-06-04 - 2.1.0 — 2019-05-08 - 2.0.0 — 2019-03-22 - 1.5.0 — 2019-03-22 - 1.4.0 — 2019-03-21 - 1.3.0 — 2019-03-21 - 1.2.0 — 2018-08-29 - … 12 more at https://npm.io/package/sliding-window-rate-limiter/versions ## README # sliding-window-rate-limiter [![GitHub](https://img.shields.io/github/v/release/dex4er/js-sliding-window-rate-limiter?display_name=tag&sort=semver)](https://github.com/dex4er/js-sliding-window-rate-limiter) [![CI](https://github.com/dex4er/js-sliding-window-rate-limiter/actions/workflows/ci.yaml/badge.svg)](https://github.com/dex4er/js-sliding-window-rate-limiter/actions/workflows/ci.yaml) [![Trunk Check](https://github.com/dex4er/js-sliding-window-rate-limiter/actions/workflows/trunk.yaml/badge.svg)](https://github.com/dex4er/js-sliding-window-rate-limiter/actions/workflows/trunk.yaml) [![Coverage Status](https://coveralls.io/repos/github/dex4er/js-sliding-window-rate-limiter/badge.svg)](https://coveralls.io/github/dex4er/js-sliding-window-rate-limiter) [![npm](https://img.shields.io/npm/v/sliding-window-rate-limiter.svg)](https://www.npmjs.com/package/sliding-window-rate-limiter) Sliding window rate limiter with Redis >= 3.2 backend or in-memory backend. ## Requirements This module requires ES6 with Node >= 16. Redis >= 3.2.0 is required for the Redis backend. ## Installation ```shell npm install sliding-window-rate-limiter ``` _Additionally for Typescript:_ ```shell npm install -D @types/node @types/ioredis ``` ## Usage ```js const {SlidingWindowRateLimiter} = require("sliding-window-rate-limiter") ``` _Typescript:_ ```ts import SlidingWindowRateLimiter from "sliding-window-rate-limiter" // or import {SlidingWindowRateLimiter} from "sliding-window-rate-limiter" ``` ### constructor ```js const limiter = SlidingWindowRateLimiter.createLimiter(options) ``` _Options:_ - `interval` is a number of milliseconds in a sliding window - `redis` is an instance of [`ioredis`](https://www.npmjs.com/package/ioredis) or URL string to Redis server (only for Redis backend) - `operationTimeout` is the time in milliseconds after Redis operation is canceled (for Redis and SafeRedis backends, optional) - `safe`: `true` (only for SafeRedis backend) `reuseRedisAfter` is the time (milliseconds) to reconnect to the Redis server after connection failure (only for SafeRedis backend, default value: 2000 milliseconds) If `redis` parameter is a string then a new `ioredis` object is created with `retryStrategy` set to 1 second and `maxRetriesPerRequest` set to 1. _Example:_ ```js const limiter = SlidingWindowRateLimiter.createLimiter({ interval: 60000, }) ``` or ```js const limiter = SlidingWindowRateLimiter.createLimiter({ interval: 60000, redis: new Redis({ host: "redis-server", retryStrategy: _times => 1000, maxRetriesPerRequest: 1, }), safe: true, }) ``` ### check ```js const result = await limiter.check(key, limit) const {usage, reset} = result ``` Checks current usage for `key`. If `usage` is equal to or above `limit`, additionally sets `reset` time in milliseconds. ### reserve ```js const result = await limiter.reserve(key, limit) const {token, usage, reset} = result ``` Makes a reservation and returns `token` with a reservation. If `usage` is equal to or above `limit`, additionally sets `reset` time in milliseconds. Throws an error if has occurred. ### cancel ```js const result = await limiter.cancel(key, token) const {canceled} = result ``` Cancels a reservation for `token` and returns the number of `canceled`` tokens. It is a zero if no token previously was reserved or it was expired. ### destroy ```js limiter.destroy() ``` Frees resources used by limiter (timers and Redis connection if created by limiter itself). ## Errors If `reserve` or `usage` methods return an error: ```console ERR Error running script (call to f_8ff6a0f745b738fe1d9fa74079c4c13d032e9947): @user_script:1: user_script:1: attempt to call field \'replicate_commands\' (a nil value) ``` then check if Redis has the proper version (>= 3.2.0). ## Backends ### Memory This backend holds all data in memory. ### Redis This backend requires Redis 3.2 to work. The main advantage is that the state of the limiter can be shared between many clients. ### SafeRedis There is an extended version of the limiter, which behaves gracefully when the Redis server is unavailable for any reason. In case of Redis connection failure, SafeRedis backend will always return a positive response object and will try to use again the Redis server after `reuseRedisAfter`. ## License Copyright (c) 2017-2024 Piotr Roszatycki [MIT](https://opensource.org/licenses/MIT) Based on Lua script from Copyright (c) 2017 Serguei Poliakov Inspired by ClassDojo blog note and [`rolling-rate-limiter`](https://www.npmjs.com/package/rolling-rate-limiter) module. --- _Source: https://npm.io/package/sliding-window-rate-limiter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._