Giter Club home page Giter Club logo

hapi-limiter's Introduction

Build Status Coverage Status npm version dependencies

hapi-limiter

Rate limiting plugin for Hapi, inspired by hapi-ratelimit, but using hapi's builtin server cache interface.

Installation

npm install hapi-limiter

Usage

server.register(require('hapi-limiter'), function(err) {
  Hoek.assert(!err, 'uh oh!');
});

server.route({
  path: '/foo',
  method: 'get',
  handler: function(request, reply) {
    reply('remaining requests: ', request.plugins[hapi-limiter].remaining);
  },
  config:{
    plugins: {
      'hapi-limiter': {
        enable: true
      }
    }
  }
});

Configuration

Plugin

These settings are global, and applicable values are applied as defaults to each rate limted route

Setting Description Default
ttl Length of time that a limit should be enforced for, specified in miliseconds 1000 * 60 * 15
limit Maximum allowed API calls per period specified by ttl 15
cacheClient A Hapi CacheClient, or similarly functioning interface. undefined
cache A Hapi Catbox policy default ttl and segment, using default server cache
generateKeyFunc A function with the signature function(request) {} that returns the caching key returns method + api path + ip address

Route Configuration

Setting Description Default
enable boolean or truthy value, indicating if route is to be rate limited undefined
ttl Length of time that a limit should be enforced for, specified in miliseconds 1000 * 60 * 15
limit Maximum allowed API calls per period specified by ttl 15

hapi-limiter's People

Contributors

cadecairos avatar

Watchers

 avatar

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.