Git Product home page Git Product logo

node-redis-rolling-limit's Introduction

redis-rolling-limit

A rolling rate limit using Redis. Original idea from Peter Hayes. Uses a lua script for atomic operations and to prevent blocked actions from substracting from the bucket.

Usage

var RollingLimit = require('redis-rolling-limit');

RollingLimit Methods

limiter = new RollingLimit(options)

Creates a new RollingLimit instance.

Options:

  • limit: (required) maximum of allowed uses in interval
  • interval: (required) millisecond duration for the limit
  • redis: (required) an instance of RedisClient
  • prefix: (optional) a string to prepend before id for each key

limiter.use(id, callback)

limiter.use(id, amount, callback)

Takes a token from the limit's bucket for id in redis and calls callback with (error, numLeft). numLeft is the number of tokens left in the bucket. amount is the number of tokens to take from the bucket and defaults to 1. If you wanted to get the count of tokens left, send in an amount of 0.

Returns a promise that can be used instead of the callback.

limiter.fill(id, callback)

Re-fills the bucket for id in redis to max capacity. callback is called with (error). Returns a promise that can be used instead of the callback.

node-redis-rolling-limit's People

Contributors

jameshartig avatar

Watchers

James Cloos avatar Jason Bond Pratt 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.