koa-session-store2

Requires Node 7.6 or greater for async/await support

Getting Started

Installation

$ npm install koa-session-store2

Running Tests

Notice: please check test/config.js content
$ npm install
$ npm test

Examples

1const session = require('koa-session');
2const Koa = require('koa');
3const app = new Koa();
4
5// memcached, redis, mysql example
6// Notice: Requires mysql 5.6 or grater for default value now()
7const {MemcachedStore, RedisStore, MysqlStore} = require('koa-session-store2');
8
9app.keys = ['some secret hurr'];
10 
11const CONFIG = {
12    key: 'koa:sess', /** (string) cookie key (default is koa:sess) */
13    /** (number || 'session') maxAge in ms (default is 1 days) */
14    /** 'session' will result in a cookie that expires when session/browser is closed */
15    /** Warning: If a session cookie is stolen, this cookie will never expire */
16    maxAge: 86400000,
17    autoCommit: true, /** (boolean) automatically commit headers (default true) */
18    overwrite: true, /** (boolean) can overwrite or not (default true) */
19    httpOnly: true, /** (boolean) httpOnly or not (default true) */
20    signed: true, /** (boolean) signed or not (default true) */
21    rolling: false, /** (boolean) Force a session identifier cookie to be set on every response. The expiration is reset to the   original maxAge, resetting the expiration countdown. (default is false) */
22    renew: false, /** (boolean) renew session when session is nearly expired, so we can always keep user logged in. (default is false)*/
23    // store: new MemcachedStore(), /* defualt memcached config: localhost:11211 example: https://www.npmjs.com/package/memcached */
24    // store: new RedisStore(),
25    store: new MysqlStore('t_', 
26        {
27          host     : '',
28          user     : '',
29          password : '',
30          database : ''
31        }
32    ),
33};
34 
35app.use(session(CONFIG, app));
36
37app.use(ctx => {
38    // ignore favicon
39    if (ctx.path === '/favicon.ico') return;
40  
41    let n = ctx.session.views || 0;
42    ctx.session.views = ++n;
43    ctx.body = n + ' views';
44});
45 
46app.listen(3000);
47console.log('listening on port 3000');

License

MIT