Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaelzhang/node-engine-x
engine-x, nginx the node version.
https://github.com/kaelzhang/node-engine-x
Last synced: 17 days ago
JSON representation
engine-x, nginx the node version.
- Host: GitHub
- URL: https://github.com/kaelzhang/node-engine-x
- Owner: kaelzhang
- License: other
- Created: 2016-09-06T01:38:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-07T12:12:52.000Z (about 8 years ago)
- Last Synced: 2024-04-15T12:33:01.630Z (7 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
[](https://travis-ci.org/kaelzhang/node-engine-x)
# engine-x
EnGINe-X, nginx the node version, the reverse proxy for node.
`engine-x` is the subset of nginx, and only cares about the things inside the `server` directive of nginx, and does not care about:
- `listen`
- `server_name`
supported directives
- location
- rewrite
- root
- proxy_pass
## Install
```sh
$ npm install engine-x --save
```
## `nginx.Router`
```js
const {
Router
} = require('engine-x')
const router = new Router({
routes: [
// The matching priority of locations follows the
{
// same as `location /app {...}` directive of nginx.
location: '/app',
// `root` could be a path or an array of paths, as well as below.
root: '/path/to'
},
{
// same as `location = /app/legacy {...}` directive of nginx
location_is: '/app/legacy',
root: '/legacy/path/to'
},
{
// same as `location ~* -[a-z0-9]{7}\.png$/` directive of nginx
location: /-[a-z0-9]{7}\.png$/i,
// rewrite '/path/to/a-28dfeg0.png' -> '/path/to/a.png'
rewrite: (url, redirect) => {
return url.replace(/-[a-z0-79]{32}\.([a-z0-9]+)$/i, (m, p1) => {
return `.${p1}`
})
}
},
{
// Location could be a function
location: pathname => pathname === '/favicon.ico',
root: '/icon'
}
],
// if no location matched, then use default root
root: '/path/to/default/root',
// if no location is matched,
// and if no root specified, or no matched file found within root,
// then will proxy pass to the server
proxy_pass: 'http://domain.com'
})
router
.route({
pathname: '/app/a-28dfeg0.png'
})
.on('found', (filename) => {
filename // '/path/to/app/a.png'
})
// will not be called
.on('proxy-pass', (url) => {
})
```
## Directives
### root
Could be a path or an array of paths
### rewrite(url, redirect)
- **url** `URL` url to be rewritten
- **redirect** `function(redirect_url, is_permanent)`
nginx
```nginx
rewrite {pattern} {url_rewritten} {last};
```
- use `if` condition of javascript to handle `last` or `break` flag of nginx
- the return value of `rewrite(url)` is as `url_rewritten` if function `redirect` not called
##### nginx `redirect` flag
nginx
```nginx
rewrite {pattern} {redirect_url} redirect;
```
rewrite
```js
{
rewrite: (url, redirect) => {
redirect(redirect_url)
}
}
```
##### nginx `permanent` flag
```nginx
rewrite {pattern} {redirect_url} permanent;
```
rewrite
```js
{
rewrite: (url, redirect) => {
// set `is_permanent` to `true`
redirect(redirect_url, true)
}
}
```
## Events
- `'not-found'`
- `'found'`
- `'error'`
- `'redirect'`
- `'return'`
- `'proxy-pass'`
## License
MIT