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