# koa-unless

> Conditionally add a middleware to Koa with some common patterns.

Latest version **1.0.7** (published 2017-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-unless
pnpm add koa-unless
yarn add koa-unless
bun add koa-unless
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2017-03-24 |
| First published | 2015-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 64 |
| Author | Jesus Rodriguez |
| Maintainers | brunokrebs |
| Keywords | koa, middleware, unless |

## Links

- npm: https://www.npmjs.com/package/koa-unless
- Repository: https://github.com/Foxandxss/koa-unless
- Homepage: https://github.com/Foxandxss/koa-unless#readme
- Issues: https://github.com/Foxandxss/koa-unless/issues
- npm.io page: https://npm.io/package/koa-unless

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2017-03-24
- 0.0.2 — 2017-03-24
- 1.0.6 — 2017-03-24
- 1.0.5 — 2017-03-24
- 1.0.0 — 2016-04-28
- 0.0.1 — 2015-05-27

## README

# Koa Unless

![Build Status](https://travis-ci.org/Foxandxss/koa-unless.svg?branch=master)

Conditionally skip a middleware when a condition is met.

## Install

	npm i koa-unless --save

## Usage

With existing middlewares:

```javascript
var unless = require('koa-unless');
var serve  = require('koa-static');

var static = serve(__dirname + '/public');
static.unless = unless;

app.use(static.unless({ method: 'OPTIONS' }));
```

If you are authoring a middleware you can support unless as follow:

```javascript
module.exports = function () {
  var mymid = function(ctx, next) {
	// Do something
  };

  mymid.unless = require('koa-unless');

  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. 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 returns `true` / `false`. If the function returns true for the given request, ithe middleware will not run. The function will have access to Koa's context via `this`
-  `useOriginalUrl` it should be `true` or `false`, default is `true`. if false, `path` will match against `ctx.url` instead of `ctx.originalUrl`.


## Examples

Require authentication for every request unless the path is index.html.

```javascript
app.use(requiresAuth.unless({ path: ['/index.html', '/'] }))
```

Avoid a fstat for request to routes doesnt end with a given extension.

```javascript
app.use(static.unless(function () {
  var ext = url.parse(this.originalUrl).pathname.substr(-4);
  return !~['.jpg', '.html', '.css', '.js'].indexOf(ext);
}));
```

## Credits

All the credits for this library goes for [José F. Romaniello](https://github.com/jfromaniello) which created the original [express version](https://github.com/jfromaniello/express-unless).

## License

MIT 2015 - Jesús Rodríguez

---
_Source: https://npm.io/package/koa-unless · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._