I (@DaAwesomeP) now help maintain koa/koa-redis.
Redis store-based session middleware for Koa. This version adds the keySchema
option to use a prefix on Redis keys. It also adds hiredis
and puid
.
Forked from koa-session-redis. Based on koa-session.
$ npm install koa-session-redis3
When it installs it should also include hiredis
, which is a native module. If it fails to build, then no worries (it is only a speed improvement), as it will fall back to the JavaScript parser.
var session = require('koa-session-redis3');
var koa = require('koa');
var app = koa();
app.keys = ['some secret hurr'];
app.use(session({
store: {
host: process.env.SESSION_PORT_6379_TCP_ADDR || '127.0.0.1',
port: process.env.SESSION_PORT_6379_TCP_PORT || 6379,
ttl: 3600,
keySchema: 'your:schema'
},
},
));
app.use(function *(){
var n = this.session.views || 0;
this.session.views = ++n;
this.body = n + ' views';
});
app.listen(3000);
console.log('listening on port 3000');
This module provides "guest" sessions, meaning any visitor will have a session, authenticated or not. If a session is new a Set-Cookie will be produced regardless of populating the session.
The cookie name is controlled by the key
option, which defaults to "koa:sess". All other options are passed to ctx.cookies.get()
and ctx.cookies.set()
allowing you to control security, domain, path, and signing among other settings.
Returns true if the session is new.
To destroy a session simply set it to null
:
this.session = null;