npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

entrypool

v0.3.0

Published

Array pooling for easier rate limiting

Downloads

4

Readme

EntryPool

Simple array pooling with entry (i.e. time) adding/counting for simple rate limiting. See the example at the bottom for help with using this for rate limiting.

EntryPool Methods

pool = new EntryPool(initialSize, arrayLength[,stepSize])

Returns a new pool of arrays of length arrayLength with an initial size of initialSize. stepSize is used when adding to the poll and defaults to initialSize or "double pool".

pool.get()

Gets a new EntryArray of length arrayLength from the pool.

pool.put(array)

Puts back an EntryArray once its done being used.

pool.add([num])

Adds num arrays of length arrayLength to the pool. If no num is passed, it will use the step size.

pool.trim([minSize])

Reduces pool size to at least minSize (or 0) by removing unused arrays from the pool.

EntryArray Methods

arr.add(timestamp[, value])

Adds an entry to the array. You should add an entry for each thing you want to limit. Returns the index at which entry was added or -1 if array is full.

arr.remove([timestamp][, value])

Removes an entry from array. Returns true if array is now empty. timestamp and value are both optional and to omit timestamp but send value pass undefined as timestamp.

arr.cleanup(maxEntry)

Removes any entries with a timestamp older than maxEntry from array. Returns number of entries left.

arr.numEntries()

Removes the number of entries in array.

Example

var connectionsPerIP = {},
    //only allow up to 5 connections every minute
    maxAllowedConnections = 5,
    maxAllowedTimeframe = 60 * 1000,
    pool = new EntryPool(100, maxAllowedConnections); 

// server is a http.Server
server.on('connection', function(socket) {
    var now = Date.now(),
        ip = socket.remoteAddress;
    if (!connectionsPerIP[ip]) {
        connectionsPerIP[ip] = pool.get();
    } else {
        // remove any entries older than the allowed timeframe
        connectionsPerIP[ip].cleanup(now - maxAllowedTimeframe);
    }
    // store that they just connected
    if (connectionsPerIP[ip].add(now) < 0) {
        // the user is over the rate-limit so end the connection immediately 
        socket.end();
        return;
    }
    socket.on('close', function() {
        // if the array is now empty then we need to remove it
        if (connectionsPerIP[ip].cleanup(now - maxAllowedTimeframe) === 0) {
            pool.put(connectionsPerIP[ip]);
            delete connectionsPerIP[ip];
        }
    });
};
    
// if a connection was open for less than maxAllowedTimeframe then we didn't remove the entry from
// the array when they closed. this interval will cleanup any that are expired
setInterval(function() {
    var cleanupIfBefore = Date.now() - maxAllowedTimeframe;
    for (var ip in connectionsPerIP) {
        if (connectionsPerIP[ip].cleanup(cleanupIfBefore) === 0) {
            pool.put(connectionsPerIP[ip]);
            delete connectionsPerIP[ip];
        }
    }
}, 10 * maxAllowedTimeframe);

By James Hartig