Skip to content

Simple, full featured, nestable router for diet.js

License

Notifications You must be signed in to change notification settings

4strid/diet-router

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

diet-router

Simple, full featured, nestable router for diet.js

Supports all of diet's HTTP methods (namely get, post, put, patch, delete, and trace)

const server = require('diet')
const Router = require('diet-router')

const app = server()
Router.extend(app)

const router = Router()

app.route('/router', router)

router.get('/subroute', function ($) {
	$.end('response')
})

// accessible at /router/subroute

Add routes before or after calling route. This lets you write your routers in separate files

// router1.js
const router = Router()

router.get('/subroute', function ($) {
	$.end('response')
})

module.exports = router
// main.js
const router1 = require('./router1')

app.route('/route', router1)

If you don't want to extend diet's app object, you can skip calling Router.extend and call the router directly, passing the app object as the first argument

const router = Router()
router.get('/subroute', function ($) {
	$.end('response')
})
router(app, '/route')

Middleware

The router supports adding middleware to be run before each subroute. You can add it when calling Router or when calling app.route

const router = Router()
app.route('/path', function ($) {
	// this is middleware
	$.return()
}, barware, etcware, router)

Note that the router is the last argument passed

Alternatively:

const router = Router(fooware, barware, etcware)
app.route('/path', router)

Nested Routing

The router supports nesting a router within another router

const router1 = Router()
const router2 = Router()

app.route('/route', router1)

router1.route('/nested', router2)

router2.get('/subroute', function ($) {
	$.end('response')
})
// accessible at /route/nested/subroute

Middleware can be added anywhere along the chain

const router1 = Router()
const router2 = Router()

app.route('/route', fooware, router1)

router1.route('/nested', barware, router2)

router2.get('/subroute', bazware, function ($) {
	$.end('response')
})

// runs fooware, then barware, then bazware, and finally the function that returns the response

Contact

Bug reports, feature requests, and questions are all welcome. Just open a GitHub issue and I'll get back to you

About

Simple, full featured, nestable router for diet.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published