Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj/connect-redis
Redis session store for Connect
https://github.com/tj/connect-redis
Last synced: 15 days ago
JSON representation
Redis session store for Connect
- Host: GitHub
- URL: https://github.com/tj/connect-redis
- Owner: tj
- License: mit
- Created: 2010-07-12T19:47:08.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T16:24:57.000Z (10 months ago)
- Last Synced: 2024-05-17T12:02:58.914Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 398 KB
- Stars: 2,781
- Watchers: 60
- Forks: 345
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
 [](https://npmjs.com/package/connect-redis) [](https://gitter.im/jlongster/prettier) 
**connect-redis** provides Redis session storage for Express.
## Installation
**connect-redis** requires `express-session` to installed and one of the following compatible Redis clients:
- [`redis`][1]
- [`ioredis`][2]
Install with `redis`:
```sh
npm install redis connect-redis express-session
```
Install with `ioredis`:
```sh
npm install ioredis connect-redis express-session
```
## Importing
**connect-redis** supports both CommonJS (`require`) and ESM (`import`) modules.
Import using ESM/Typescript:
```js
import RedisStore from "connect-redis"
```
Require using CommonJS:
```js
const RedisStore = require("connect-redis").default
```
## API
Full setup using [`redis`][1] package:
```js
import RedisStore from "connect-redis"
import session from "express-session"
import {createClient} from "redis"
// Initialize client.
let redisClient = createClient()
redisClient.connect().catch(console.error)
// Initialize store.
let redisStore = new RedisStore({
client: redisClient,
prefix: "myapp:",
})
// Initialize session storage.
app.use(
session({
store: redisStore,
resave: false, // required: force lightweight session keep alive (touch)
saveUninitialized: false, // recommended: only save session when data exists
secret: "keyboard cat",
}),
)
```
### RedisStore(options)
#### Options
##### client
An instance of [`redis`][1] or [`ioredis`][2].
##### prefix
Key prefix in Redis (default: `sess:`).
**Note**: This prefix appends to whatever prefix you may have set on the `client` itself.
**Note**: You may need unique prefixes for different applications sharing the same Redis instance. This limits bulk commands exposed in `express-session` (like `length`, `all`, `keys`, and `clear`) to a single application's data.
##### ttl
If the session cookie has a `expires` date, `connect-redis` will use it as the TTL.
Otherwise, it will expire the session using the `ttl` option (default: `86400` seconds or one day).
```ts
interface RedisStoreOptions {
...
ttl?: number | {(sess: SessionData): number}
}
```
`ttl` also has external callback support. You can use it for dynamic TTL generation. It has access to `session` data.
**Note**: The TTL is reset every time a user interacts with the server. You can disable this behavior in _some_ instances by using `disableTouch`.
**Note**: `express-session` does not update `expires` until the end of the request life cycle. _Calling `session.save()` manually beforehand will have the previous value_.
##### disableTouch
Disables resetting the TTL when using `touch` (default: `false`)
The `express-session` package uses `touch` to signal to the store that the user has interacted with the session but hasn't changed anything in its data. Typically, this helps keep the users session alive if session changes are infrequent but you may want to disable it to cut down the extra calls or to prevent users from keeping sessions open too long. Also consider enabling if you store a lot of data on the session.
Ref:
##### disableTTL
Disables key expiration completely (default: `false`)
This option disables key expiration requiring the user to manually manage key cleanup outside of `connect-redis`. Only use if you know what you are doing and have an exceptional case where you need to manage your own expiration in Redis.
**Note**: This has no effect on `express-session` setting cookie expiration.
##### serializer
Provide a custom encoder/decoder to use when storing and retrieving session data from Redis (default: `JSON.parse` and `JSON.stringify`).
Optionally `parse` method can be async if need be.
```ts
interface Serializer {
parse(string): object | Promise
stringify(object): string
}
```
##### scanCount
Value used for _count_ parameter in [Redis `SCAN` command](https://redis.io/commands/scan#the-count-option). Used for `ids()` and `all()` methods (default: `100`).
[1]: https://github.com/NodeRedis/node-redis
[2]: https://github.com/luin/ioredis