express-map2
v1.0.9
Published
adds a convenient route mapping function to define a group of routes with prefix and assign/autoload middleware and controllers.
Downloads
7
Maintainers
Readme
express-map2 ( not to be confused with Yahoo's express-map
package which does a totally different thing )
adds map() function to express.
install
npm install --save express-map2
usage
setup
var app = require('express'); // 1. include express
app.set('controllers',__dirname+'/controllers/');// 2. set path to your controllers.
require('express-map2')(app); // 3. patch map into express
types of usage supported
// without prefix
app.map({
'GET /':'test',
'GET /foo':'middleware.foo,test',
'GET /bar':'middleware.bar,test'// seperate your handlers with a comma.
});
// with prefix
app.map('/api/v1/books',{
'GET /': 'books.list',
'GET /:id': 'books.loadOne',
'DELETE /:id': 'books.delete',
'PUT /:id': 'books.update',
'POST /': 'books.create'
});
//with single middleware passed
const AuthenticateUser2 = function(req,res,next){}
app.map(AuthenticateUser2,{
'GET /': 'User.dashboard',
'GET /sessions-list':'User.sessions'
});
//without prefix and with middleware
app.map('/api/v1/books',AuthenticateUser,{
'GET /': 'books.list',
'GET /:id': 'books.loadOne',
'DELETE /:id': 'books.delete',
'PUT /:id': 'books.update',
'POST /': 'books.create'
});
app.listen(3000);
testing
testing is done with mocha. to run tests:
- clone the repo
git clone https://github.com/r3wt/express-map.git
- change into project directory install dependencies
npm install
- make sure to have mocha installed globally
npm install --global mocha
. - run tests with
npm test