@swyftx/express-unless-and
v1.0.3
Published
Conditionally add a middleware to express with some common patterns.
Downloads
3
Keywords
Readme
Conditionally skip a middleware when a condition is met. Conditions are ANDed instead of ORed like express-unless.
Install
npm i express-unless-and --save
Usage
With existing middlewares:
const unless = require('express-unless-and')
const static = express.static(__dirname + '/public')
static.unless = unless
app.use(static.unless({ method: 'OPTIONS' }))
If you are authoring a middleware you can support unless as follow:
module.exports = function (middlewareOptions) {
let mymid = function (req, res, next) {
}
mymid.unless = require('express-unless-and')
return mymid
}
Current options
method
it could be an string or an array of strings. If the request method match the middleware will not run.path
it could be an string, a regexp or an array of any of those. It also could be an array of object which is url and methods key-pairs. If the request path or path and method match, the middleware will not run. Check Examples for usage.ext
it could be an 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 acceptsreq
and returnstrue
/false
. If the function returns true for the given request, ithe middleware will not run.useOriginalUrl
it should betrue
orfalse
, default istrue
. if false,path
will match againstreq.url
instead ofreq.originalUrl
. Please refer to Express API for the difference betweenreq.url
andreq.originalUrl
.
Examples
Require authentication for every request unless the path is index.html.
app.use(requiresAuth.unless({
path: [
'/index.html',
{ url: '/', methods: ['GET', 'PUT'] }
]
}))
Avoid an fstat for request to routes that don't end with a given extension.
app.use(static.unless(function (req) {
let ext = url.parse(req.originalUrl).pathname.substr(-4)
return !~['.jpg', '.html', '.css', '.js'].indexOf(ext)
}))
License
MIT 2014 - Jose Romaniello