# @types/redis-rate-limiter

> TypeScript definitions for redis-rate-limiter

Latest version **1.2.7** (published 2025-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/redis-rate-limiter
pnpm add @types/redis-rate-limiter
yarn add @types/redis-rate-limiter
bun add @types/redis-rate-limiter
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.2.7 |
| Published | 2025-10-24 |
| First published | 2016-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/redis-rate-limiter
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-rate-limiter
- npm.io page: https://npm.io/package/@types/redis-rate-limiter

## Dependencies (2)

- [@types/redis](https://npm.io/package/@types/redis.md) ^2.8.0
- [@types/express](https://npm.io/package/@types/express.md) *

## Recent versions

- 1.2.7 (latest) — 2025-10-24
- 1.2.6 (ts5.1) — 2023-11-07
- 1.2.3 (ts4.0) — 2021-12-09
- 1.2.2 (ts3.7) — 2021-07-08
- 1.2.1 (ts3.5) — 2019-02-13
- 1.0.3 (ts2.2) — 2016-09-19
- 1.2.5 — 2023-10-18
- 1.2.4 — 2023-09-27
- 1.2.0 — 2018-11-21
- 1.0.4 — 2017-10-25
- 1.0.2 — 2016-08-25
- 1.0.1 — 2016-08-22

## README

# Installation
> `npm install --save @types/redis-rate-limiter`

# Summary
This package contains type definitions for redis-rate-limiter (https://github.com/tabcorp/redis-rate-limiter).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-rate-limiter.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redis-rate-limiter/index.d.ts)
````ts
import express = require("express");
import * as redis from "redis";

declare class RedisRateLimiter {
    public static create(
        options: RedisRateLimiter.Options,
    ): (req: express.Request, callback: (err: Error, res: RedisRateLimiter.Response) => void) => void;
    public static middleware(options: RedisRateLimiter.Options): express.RequestHandler;
}

declare namespace RedisRateLimiter {
    export interface Options {
        redis: redis.RedisClient;
        key: "ip" | ((req: express.Request) => string);
        window?: number | undefined;
        limit?: number | undefined;
        rate?: string | undefined;
        deleteImmediatelyIfRaceCondition?: boolean | undefined;
        onPossibleRaceCondition?: ((key: string) => void) | undefined;
    }

    export interface Response {
        key: string;
        current: number;
        limit: number;
        window: number;
        over: boolean;
    }
}

export = RedisRateLimiter;

````

### Additional Details
 * Last updated: Fri, 24 Oct 2025 04:02:41 GMT
 * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/redis](https://npmjs.com/package/@types/redis)

# Credits
These definitions were written by [Seth Westphal](https://github.com/westy92), and [Hasan Oezdemir](https://github.com/nodify-at).

---
_Source: https://npm.io/package/@types/redis-rate-limiter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._