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

tokenpipe

v2.0.0

Published

A simple, tested implementation of a 'token bucket' algorithm.

Downloads

17

Readme

tokenpipe

A simple, tested implementation of a 'token bucket' algorithm.

Code Example

const TokenPipe = require( 'tokenpipe' );
const tokenPipe = TokenPipe( {
    rate: '10/second'
} );

(function example() {
    if ( tokenPipe.consume() ) {
        console.log( 'below rate limit' );
    }
    else {
        console.log( 'over rate limit' );
    }

    setTimeout( example, Math.random() * 100 );
})();

Motivation

The various token bucket implementations I came across either:

  • didn't have tests
  • weren't standalone, were part of a larger project
  • were complex to configure

Installation

npm install --save tokenpipe

API Reference

factory method

const TokenPipe = require( 'tokenpipe' );

const defaultPipe = TokenPipe(); // defaults to 1/s

const rateDefinedPipe = TokenPipe( {
    rate: '10/minute'
} );

const countAndPeriodDefinedPipe = TokenPipe( {
    count: 10,
    period: 1000 * 60
} );

Object.assign

const TokenPipe = require( 'tokenpipe' ).TokenPipe;

const tokenPipe = Object.assign( {}, TokenPipe, {
    count: 10,
    period: 1000 * 60;
} );

TokenPipe.consume()

const TokenPipe = require( 'tokenpipe' );
const tokenPipe = TokenPipe( {
    rate: '10/s'
} );

tokenPipe.consume(); // returns true if there are available tokens, false otherwise

Tests

npm run test

Contributors

If you'd like to contribute:

  1. Add tests for any new feature or bugfix
  2. Ensure your code passes jshint according to the .jshintrc
  3. Ensure your code is formatted according to the .jsbeautifyrc
  4. Submit a Pull Request

License

MIT