| 1 |
|
| 2 | # flash
|
| 3 |
|
| 4 | [![NPM version][npm-image]][npm-url]
|
| 5 | [![Build status][travis-image]][travis-url]
|
| 6 | [![Test coverage][coveralls-image]][coveralls-url]
|
| 7 | [![Dependency Status][david-image]][david-url]
|
| 8 | [![License][license-image]][license-url]
|
| 9 | [![Downloads][downloads-image]][downloads-url]
|
| 10 |
|
| 11 | The simplest flash implementation for Express.
|
| 12 |
|
| 13 | ## Usage
|
| 14 |
|
| 15 | ```bash
|
| 16 | npm i flash
|
| 17 | ```
|
| 18 |
|
| 19 | ```js
|
| 20 | app.use(session()); // session middleware
|
| 21 | app.use(require('flash')());
|
| 22 |
|
| 23 | app.use(function (req, res) {
|
| 24 | // flash a message
|
| 25 | req.flash('info', 'hello!');
|
| 26 | next();
|
| 27 | })
|
| 28 | ```
|
| 29 |
|
| 30 | ```jade
|
| 31 | for message in flash
|
| 32 | a.alert(class='alert-' + message.type)
|
| 33 | p= message.message
|
| 34 | ```
|
| 35 |
|
| 36 | ## API
|
| 37 |
|
| 38 | ### req.flash([type], msg)
|
| 39 |
|
| 40 | Flash a message defaulting the `type` to `info`.
|
| 41 |
|
| 42 | ### res.locals.flash
|
| 43 |
|
| 44 | An array of flash messages of the form:
|
| 45 |
|
| 46 | ```json
|
| 47 | {
|
| 48 | "type": "info",
|
| 49 | "message": "message"
|
| 50 | }
|
| 51 | ```
|
| 52 |
|
| 53 | [npm-image]: https://img.shields.io/npm/v/flash.svg?style=flat-square
|
| 54 | [npm-url]: https://npmjs.org/package/flash
|
| 55 | [github-tag]: http://img.shields.io/github/tag/expressjs/flash.svg?style=flat-square
|
| 56 | [github-url]: https://github.com/expressjs/flash/tags
|
| 57 | [travis-image]: https://img.shields.io/travis/expressjs/flash.svg?style=flat-square
|
| 58 | [travis-url]: https://travis-ci.org/expressjs/flash
|
| 59 | [coveralls-image]: https://img.shields.io/coveralls/expressjs/flash.svg?style=flat-square
|
| 60 | [coveralls-url]: https://coveralls.io/r/expressjs/flash?branch=master
|
| 61 | [david-image]: http://img.shields.io/david/expressjs/flash.svg?style=flat-square
|
| 62 | [david-url]: https://david-dm.org/expressjs/flash
|
| 63 | [license-image]: http://img.shields.io/npm/l/flash.svg?style=flat-square
|
| 64 | [license-url]: LICENSE
|
| 65 | [downloads-image]: http://img.shields.io/npm/dm/flash.svg?style=flat-square
|
| 66 | [downloads-url]: https://npmjs.org/package/flash
|
| 67 | [gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square
|
| 68 | [gittip-url]: https://www.gittip.com/jonathanong/
|