The express-notices
module provides a simple middleware for throwing high-level error, warning and information messages.
Works best with client-side frameworks (e.g. ScalpelJS).
Install it:
npm install express-notices
Configure your app to use notices (somewhere above your main router, but below session configuration):
// Your session configuration
// ...
app.use(require('express-notices'));
// ...
app.use(express.router);
This installs notices
object into:
res
to use it inside routesres.locals
to access it in your templates
In your routes:
app.get('/login', function(req, res, next) {
res.render('login');
});
app.post('/login', function(req, res, next) {
// Check password
if (!valid) {
res.notices.error('You have entered invalid username and password.');
res.redirect('/login');
} else {
// Authenticate the user
// ...
}
})
And in your templates:
// ...
body
#notices
each notice in notices.get()
div(class="notice #{notice.kind}")= notice.msg
Just apply some styling with CSS and you're all set.
Pass parameters like this:
res.notices.info('Your request have been processed.');
res.notices.warn('The email %s has already been taken.', email);
res.notices.error('Start date %s is greated than end date %s.', startDate, endDate);
If you aren't satisfied with default notice levels — info
, warn
and error
— you can add more:
app.use(require('express-notices').extend({
goldAdd: function(amount) {
return this.add('gold', 'You have earned %s gold coins.', amount);
},
goldRemove: function(amount) {
return this.add('gold', 'You have lost %s gold coins.', amount);
}
}));
express-notices
uses i18n-2 for formatting your messages. If you don't use it, it just formats string using sprintf
.
Copyright (C) 2013 Boris Okunskiy boris@okunskiy.name (MIT license)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.