https://github.com/expressjs/urlrouter
http url router, `connect` missing router middleware
https://github.com/expressjs/urlrouter
Last synced: 8 months ago
JSON representation
http url router, `connect` missing router middleware
- Host: GitHub
- URL: https://github.com/expressjs/urlrouter
- Owner: expressjs
- Created: 2012-06-19T16:33:03.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2013-12-16T15:53:20.000Z (over 12 years ago)
- Last Synced: 2025-01-29T10:23:24.665Z (over 1 year ago)
- Language: JavaScript
- Size: 253 KB
- Stars: 60
- Watchers: 13
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
> [!CAUTION]
> **This repository is archived and no longer actively maintained.**
>
> We are no longer accepting issues, feature requests, or pull requests.
> For additional support or questions, please visit the [Express.js Discussions page](https://github.com/expressjs/express/discussions).
# urlrouter [](http://travis-ci.org/fengmk2/urlrouter) [](https://coveralls.io/r/fengmk2/urlrouter) [](https://gemnasium.com/fengmk2/urlrouter)
[](https://nodei.co/npm/urlrouter/)
`http` url router.
[connect](https://github.com/senchalabs/connect) missing router middleware.
Support [express](http://expressjs.com) format [routing](http://expressjs.com/guide.html#routing).
Support `connect` @1.8.x and @2.2.0+ .
## Test connect version
* 1.8.0+: 1.8.0 1.8.5 1.8.6 1.8.7
* 1.9.0+
* 2.2.0+
* 2.3.0+
* 2.4.0+
* 2.7.0+
* 2.8.0+
```bash
$ make test-all
```
## Install
```bash
$ npm install urlrouter
```
## Usage
### Using with `connect`
```js
var connect = require('connect');
var urlrouter = require('urlrouter');
connect(urlrouter(function (app) {
app.get('/', function (req, res, next) {
res.end('hello urlrouter');
});
app.get('/user/:id([0-9]+)', function (req, res, next) {
res.end('hello user ' + req.params.id);
});
})).listen(3000);
```
Several callbacks may also be passed.
```js
function loadUser(req, res, next) {
// You would fetch user from the db
var user = users[req.params.id];
if (user) {
req.user = user;
next();
} else {
next(new Error('Failed to load user ' + req.params.id));
}
}
app.get('/user/:id', loadUser, function () {
// ...
});
```
These callbacks can be passed within arrays as well.
```js
var middleware = [loadUser, loadForum, loadThread];
app.post('/forum/:fid/thread/:tid', middleware, function () {
// ...
});
```
### Using with `http.createServer()`
```js
var http = require('http');
var urlrouter = require('urlrouter');
var options = {
pageNotFound: function (req, res) {
res.statusCode = 404;
res.end('er... some page miss...');
},
errorHandler: function (req, res) {
res.statusCode = 500;
res.end('oops..error occurred');
}
};
function loadUser(req, res, next) {
// You would fetch user from the db
var user = users[req.params.id];
if (user) {
req.user = user;
next();
} else {
next(new Error('Failed to load user ' + req.params.id));
}
}
var routerMiddleware = urlrouter(function (app) {
app.get('/', function (req, res) {
res.end('GET home page' + req.url + ' , headers: ' + JSON.stringify(req.headers));
});
// with route middleware
app.get('/user/:id', loadUser, function (req, res) {
res.end('user: ' + req.params.id);
});
// GET /admin 301 redirect to /admin/
app.redirect('/admin', '/admin/');
app.get(/^\/users?(?:\/(\d+)(?:\.\.(\d+))?)?/, loadUser, function (req, res) {
res.end(req.url + ' : ' + req.params);
});
app.get('/foo', function (req, res) {
res.end('GET ' + req.url + ' , headers: ' + JSON.stringify(req.headers));
});
app.post('/new', function (req, res) {
res.write('POST ' + req.url + ' start...\n\n');
var counter = 0;
req.on('data', function (data) {
counter++;
res.write('data' + counter + ': ' + data.toString() + '\n\n');
});
req.on('end', function () {
res.end('POST ' + req.url + ' end.\n');
});
});
app.put('/update', function (req, res) {
res.end('PUT ' + req.url + ' , headers: ' + JSON.stringify(req.headers));
});
app.delete('/remove', function (req, res) {
res.end('DELETE ' + req.url + ' , headers: ' + JSON.stringify(req.headers));
});
app.options('/check', function (req, res) {
res.end('OPTIONS ' + req.url + ' , headers: ' + JSON.stringify(req.headers));
});
app.all('/all', function (req, res) {
res.end('ALL methods request /all should be handled' + ' , headers: ' + JSON.stringify(req.headers));
});
}, options);
http.createServer(routerMiddleware).listen(3000);
```
## Contributors
```bash
$ git summary
project : urlrouter
repo age : 1 year, 1 month
active : 16 days
commits : 38
files : 19
authors :
33 fengmk2 86.8%
4 rockdai 10.5%
1 rock 2.6%
```
## License
(The MIT License)
Copyright (c) 2012 - 2013 fengmk2 .
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.