Giter VIP home page Giter VIP logo

koa-ignore's Introduction

koa-ignore

Koa middleware to make other middleware conditional

koa 2.x

koa-ignore is koa 2.x middleware.

Installation

$ npm install koa-ignore

or

$ yarn add koa-ignore

Usage

let koa = require('koa');
let ignore = require('koa-ignore');

let app = new koa();

app.use(ignore(any, old, middleware).if(ctx=> 'json' != ctx.accepts(['json','html'])));
app.use(ignore(other).unless(isThursday);

This will cause koa to invoke the middleware 'any', 'old', and 'middleware' for requests that accept json more than html, but not for any other requests. It will also invoke the 'other' middleware only for requests on Thursdays (given the proper definition of isThursday).

API

koa-ignore

koa-ignore returns a function which takes a list of middleware and returns an object. That object contains two methods:

  • if
  • unless

Both methods return a koa middleware.

if(function)

koa-ignore will invoke the function with the context of the current request, and ignore the middleware in question if the function evaluates truthily.

For example,

let skip = require('koa-ignore');

app.use(skip(logger).if(ctx=>ctx.secure));

will skip the logger middleware for any requests that use the https protocol.

unless(function)

koa-ignore will invoke the function with the context of the current request, and ignore the middleware in question unless the function evaluates truthily.

For example,

let skip = require('koa-ignore');
let logger = skip(require('crazy-logger'));

app.use(logger.unless(()=>1073741824 < os.free()));

will skip the crazy-logger middleware unless there is at least 1 GiB of free memory available at the time of the request.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.