koa-connect-flash

The flash is a special area of the session used for storing messages. Messages are written to the flash and cleared after being displayed to the user. The flash is typically used in combination with redirects, ensuring that the message is available to the next page that is to be rendered.

This middleware was extracted from Express 2.x, after Express 3.x removed direct support for the flash. koa-connect-flash brings this functionality to koa.

Install

$ npm install koa-connect-flash

Usage

Koa

Flash messages are stored in the session. First, setup sessions using koa-generic-session middleware. Then, use flash middleware provided by koa-connect-flash.

1var koa = require('koa');
2var router = require('koa-router');
3var session = require('koa-generic-session');
4var flash = require('koa-connect-flash');
5
6var app = koa();
7
8app.keys = ['keys'];
9app.use(session());
10
11app.use(flash());
12
13app.use(router(app));

With the flash middleware in place, all requests will have a this.flash() function that can be used for flash messages.

1app.get('/flash', function *(next){
2  // Set a flash message by passing the key, followed by the value, to this.flash().
3  this.flash('info', 'Flash is back!');
4  this.redirect('/');
5});
6
7app.get('/', function *(next){
8  // Get an array of flash messages by passing the key to this.flash()
9  this.body = this.flash('info');
10});

Examples

Tests

Credits

• Jared Hanson
• TJ Holowaychuk

License

The MIT License

Copyright (c) 2012-2013 Jared Hanson <http://jaredhanson.net/>