connect-flash-plus

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. connect-flash brings this functionality back to Express 3.x, as well as any other middleware-compatible framework or application. +1 for radical reusability.

connect-flash-plus is a fork of the original connect-flash module but it contains several pull request the orginal repo still has not accepted.

Install

$ npm install connect-flash-plus

Usage

Express 4.x

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

1var express = require('express');
2var flash = require('connect-flash-plus');
3var session = require('express-session');
4var app = express();
5
6app.use(session({
7  secret: 'keyboard cat',
8  cookie: { maxAge: 60000 }
9}));
10
11app.use(flash());
12

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

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

Examples

For an example using connect-flash-plus in an Express 4.x app, refer to the express4 example.

For an example using connect-flash-plus in an Express 3.x app, refer to the express3 example.

Tests

$ npm install --dev
$ make test

Credits

• Martin Kadlec
• Jared Hanson
• TJ Holowaychuk

License

The MIT License

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