koa-session-redis-store

This is a redis store module for koa-session.
It can be used like this:

1const session = require('koa-session');
2const RedisStore = require('koa-session-redis-store');
3const Koa = require('koa');
4const app = new Koa();
5
6app.keys = ['some secret hurr'];
7
8const CONFIG = {
9  store: new RedisStore(),
10  // The others options for koa-session
11};
12
13app.use(session(CONFIG, app));
14
15app.use(ctx => {
16  // ignore favicon
17  if (ctx.path === '/favicon.ico') return;
18
19  let n = ctx.session.views || 0;
20  ctx.session.views = ++n;
21  ctx.body = n + ' views';
22});
23
24app.listen(3000);

Install

1$ npm install koa-session-redis-store

API

Constructor

1const redisStore = new RedisStore(opts);

opts: The options that will be passed to redis client(node_redis).

Events

It could catch the events from where redis client.

1redisStore.on('ready', function() {
2
3});
4
5redisStore.on('connect', function() {
6
7});
8
9redisStore.on('reconnecting', function(reconnectParams) {
10
11});
12  
13redisStore.on('error', function(err) {
14
15});
16  
17redisStore.on('end', function() {
18
19});
20
21redisStore.on('warning', function(msg) {
22
23});

Close connection

Close function is executed as asynchrous by using bluebird.

1redisStore.close()
2.delay(1000) // It allows to use the bluebird api
3.then(function(result) {
4  console.log(result);
5});

or also can be called using async/await.

1const close = async () => {
2  const result = await redisStore.close();
3  console.log(result);
4};

License

MIT