Code Monkey home page Code Monkey logo

argo-rate-limiter's Introduction

argo-rate-limiter

Rate limiting for argo.

Install

$ npm install argo-rate-limiter

Example

var argo = require('argo');
var limit = require('argo-rate-limiter');

// Allow 1 request every 5 seconds.
// Allow bursts of 2 requests every 5 seconds.
// In a burst, delay the excess request by 1 second.
var options = {
  capacity: 1,
  duration: 5000, // ms
  burst: 2,
  delay: 1000 //ms
};

argo()
  .use(limit(options))
  .get('/greeting', function(addHandler) {
    addHandler('request', function(env, next) {
      env.response.setHeader('Content-Type',  'text/plain');
      env.responseBody = 'Hello World!';
      next(env);
    });
  })
  .listen(process.env.PORT || 1337);

Usage

limit(options)

options.capacity

The number of requests allowed.

options.duration

The maximum time allowed to consume the requests at capacity (in milliseconds).

options.burst

The number of requests allowed in a burst scenario. Optional.

options.delay

A delay applied to excess requests in a burst (in milliseconds). Optional.

License

MIT

argo-rate-limiter's People

Contributors

kevinswiber avatar mdobson avatar

Watchers

 avatar  avatar

Forkers

mdobson

argo-rate-limiter's Issues

Add tests

Add some unit tests. Should be quick as this is a small module.

Update docs

I believe there are some changes from the latest Argo version. The README should be updated to reflect that.

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.