https://github.com/nickschot/lux-unless
Conditionally add a middleware to Lux with some common patterns.
https://github.com/nickschot/lux-unless
lux lux-middleware nodejs
Last synced: 8 months ago
JSON representation
Conditionally add a middleware to Lux with some common patterns.
- Host: GitHub
- URL: https://github.com/nickschot/lux-unless
- Owner: nickschot
- License: mit
- Created: 2016-10-31T12:03:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T01:21:32.000Z (over 5 years ago)
- Last Synced: 2025-05-08T03:54:51.393Z (8 months ago)
- Topics: lux, lux-middleware, nodejs
- Language: JavaScript
- Homepage:
- Size: 705 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Conditionally skip a middleware.
[](https://travis-ci.org/nickschot/lux-unless) [](https://coveralls.io/github/nickschot/lux-unless?branch=master) [](https://badge.fury.io/js/lux-unless)
This is a port of [express-unless](https://github.com/jfromaniello/express-unless) to the [Lux](https://github.com/postlight/lux) API framework.
## Install
npm i lux-unless --save
## Usage
You can use lux-unless in Lux with a middleware called `myMiddleware` as follows:
```javascript
import unless from 'lux-unless';
class ApplicationController extends Controller {
beforeAction = [
unless({path: ['/users/login']}, myMiddleware)
];
}
```
## Current options
- `method` it could be a string or an array of strings. If the request method matches, the middleware will not run.
- `path` it could be a string, a regexp or an array of any of those. It also could be an array of objects which are url and methods key-pairs. If the request path or path and method match, the middleware will not run. Check [Examples](#examples) for usage.
- `ext` it could be a string or an array of strings. If the request path ends with one of these extensions the middleware will not run.
- `custom` it must be a function that accepts `req` and returns `true` / `false`. If the function returns true for the given request, the middleware will not run.
## Examples
Require authentication for every request unless the path is index.html.
```javascript
unless({
path: [
'/index.html',
{ url: '/', methods: ['GET', 'PUT'] }
]
}, requiresAuth);
```
Avoid a fstat for request to routes which don't end with a given extension.
```javascript
unless((req) => {
let ext = url.parse(req.originalUrl).pathname.substr(-4);
return !['.jpg', '.html', '.css', '.js'].includes(ext);
}, static);
```
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.