Koa Except
Bypass koa middleware under certain conditions.
Install
npm i koa-except -S
Usage
With existing middlewares:
You can add multiple exceptions using the and()
method.
const jwt = jwtexcept = app
Equivalently, you can pass multiple conditions as an array. To be technical, the array should be in Disjuntive Normal Form (DNF), where Objects act as conjunctions and Arrays act as clauses.
const jwt = jwtexcept = app
If you are authoring a middleware you can support except as follows:
module { { // Do something } middlewareexcept = return middleware}
Current options
- opts: {Object|Array}
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 either. If the request path match, the middleware will not run.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 returnstrue
/false
. If the function returns true for the given request, ithe middleware will not run. The function will have access to Koa's context viathis
useOriginalUrl
it should betrue
orfalse
, default istrue
. if false,path
will match againstctx.url
instead ofctx.originalUrl
.
koa-except returns a koa middleware function that also exposes an and(opts)
method for chaining
Examples
Require authentication for every request except the path is index.html.
app
Avoid a fstat for request to routes doesnt end with a given extension.
app;
Serve static files except when OPTIONS request is made
const except = const serve = const static = staticexcept = except; app
Credits
This library was directly inspired by Jesús Rodríguez who published koa-unless based on José F. Romaniello's implementation of the original express version.
License
MIT 2016 - Marlin Gingerich