connect-flash
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

connect-flash

Flash message middleware for Connect.

0.1.1  •  Published 6 years ago  •  by Jared Hanson  •  Unknown License

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.

Install

$ npm install connect-flash

Usage

Express 3.x

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

var flash = require('connect-flash');
var app = express();

app.configure(function() {
  app.use(express.cookieParser('keyboard cat'));
  app.use(express.session({ cookie: { maxAge: 60000 }}));
  app.use(flash());
});

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

app.get('/flash', function(req, res){
  // Set a flash message by passing the key, followed by the value, to req.flash().
  req.flash('info', 'Flash is back!')
  res.redirect('/');
});

app.get('/', function(req, res){
  // Get an array of flash messages by passing the key to req.flash()
  res.render('index', { messages: req.flash('info') });
});

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Copyright © 2012-2013 Jared Hanson <http://jaredhanson.net/>

Ready for the next level?
Join Devstore's founding team to build the world's largest open-source knowledgebase, work with the hottest technologies, and be part of something great

Popularity

Weekly Downloads
105.7K
Stars
1.0K

Maintenance

Development

Last ver 6 years ago
Created 8 years ago
Last commit 1 year ago
3 months between commits

Technology

Node version: null
0 unpacked

Legal and Compliance

License Unknown
Not OSI Approved
0 vulnerabilities

Contributors

3 contributors
Jared Hanson
Maintainer, 24 commits, 2 merges
wlzch
1 commits, 1 PRs
Peter Wooley
1 commits, 1 PRs
sundippatel
1 PRs
saltire
1 PRs
janka102
1 PRs

Dependencies

Tags

connect
express
flash
messages
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things