static-router
Version:
Express/Connect middleware to server static files based on glob-like routes.
61 lines (41 loc) • 1.08 kB
Markdown
# static-router
Express/Connect middleware to server static files based on glob-like routes.
## Install
```
npm install static-router --save
```
## Usage
```js
var http = require('http');
var connect = require('connect');
var router = require('static-router');
var app = connect();
app.use(router({
'**': '/index.html'
}));
http.createServer(app).listen(3000, function () {
});
```
**Ensure order of routes**
```js
var http = require('http');
var connect = require('connect');
var router = require('static-router');
var app = connect();
app.use(router([
{'/some-route': '/some-file.html'},
{'**': '/index.html'}
}));
http.createServer(app).listen(3000, function () {
});
```
### router(routes[, options])
* `routes` - object or array containing globs as keys and target static files and values. Use of an array ensures the order in which the routes are parsed.
* `options`
* `root` - the root directory of the static files.
* `index` - name of the default directory index file. Defaults to `index.html`.
## Run Tests
```
npm install
npm test
```