# @types/connect-redis

> TypeScript definitions for connect-redis

Latest version **0.0.23** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 45/100 (D)** — status: abandoned.

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.23 |
| Published | 2023-11-07 |
| First published | 2016-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

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

## Dependencies (5)

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

## Recent versions

- 0.0.23 (latest) — 2023-11-07
- 0.0.21 (ts4.3) — 2023-09-04
- 0.0.20 (ts4.2) — 2023-02-12
- 0.0.19 (ts4.1) — 2022-10-26
- 0.0.18 (ts3.8) — 2021-12-09
- 0.0.17 (ts3.6) — 2021-07-06
- 0.0.16 (ts3.3) — 2020-12-09
- 0.0.15 (ts3.2) — 2020-11-09
- 0.0.14 (ts3.0) — 2020-05-15
- 0.0.13 (ts2.8) — 2019-11-14
- 0.0.11 (ts2.3) — 2019-08-19
- 0.0.10 (ts2.2) — 2019-04-29
- 0.0.6 (ts2.0) — 2017-06-15
- 0.0.22 — 2023-10-18
- 0.0.12 — 2019-11-13
- … 8 more at https://npm.io/package/@types/connect-redis/versions

## README

# Installation
> `npm install --save @types/connect-redis`

# Summary
This package contains type definitions for connect-redis (https://npmjs.com/package/connect-redis).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/connect-redis.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/connect-redis/index.d.ts)
````ts
/// <reference types="express" />
/// <reference types="express-session" />
/// <reference types="redis" />

declare module "connect-redis" {
    import * as express from "express";
    import * as session from "express-session";
    import * as ioRedis from "ioredis";
    import * as redis from "redis";

    function s(options: (options?: session.SessionOptions) => express.RequestHandler): s.RedisStore;

    namespace s {
        type Client = redis.RedisClient | ioRedis.Redis | ioRedis.Cluster;
        interface RedisStore extends session.Store {
            new(options: RedisStoreOptions): RedisStore;
            client: Client;
        }
        interface RedisStoreOptions {
            client?: Client | undefined;
            host?: string | undefined;
            port?: number | undefined;
            socket?: string | undefined;
            url?: string | undefined;
            ttl?: number | string | ((store: RedisStore, sess: session.SessionData, sid: string) => number) | undefined;
            disableTTL?: boolean | undefined;
            disableTouch?: boolean | undefined;
            db?: number | undefined;
            pass?: string | undefined;
            prefix?: string | undefined;
            unref?: boolean | undefined;
            serializer?: Serializer | JSON | undefined;
            logErrors?: boolean | ((error: string) => void) | undefined;
            scanCount?: number | undefined;
        }
        interface Serializer {
            stringify: Function;
            parse: Function;
        }
    }

    export = s;
}

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/express-session](https://npmjs.com/package/@types/express-session), [@types/node](https://npmjs.com/package/@types/node), [@types/redis](https://npmjs.com/package/@types/redis), [ioredis](https://npmjs.com/package/ioredis)

# Credits
These definitions were written by [Xavier Stouder](https://github.com/xstoudi), [Seth Butler](https://github.com/sbutler2901), and [Jip Sterk](https://github.com/JipSterk).

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