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

cldn-ratelimit

v1.2.3

Published

Simple ratelimiter for Node.js

Downloads

17

Readme

Rate limiting utility

npm npm downloads {{shield:tests}} {{shield:coverage}} {{shield:build}} CodeQL

A relatively simple utility for abstract rate limiting. This library uses memory storage (i.e. does not rely on external database or writing data on your file system). Rate limits are reset if the process is restarted.

Get started

Install package from npm

npm i cldn-ratelimit

Import in your project

Here is a very simple demo demonstrating very basic limiting of login attempts.

import {RateLimit} from 'cldn-ratelimit';

const rateLimit = new RateLimit("login-attempts", 3, 60); // max 3 requests per 60 seconds

const attemptLogin = (username, password) => {
	if (!rateLimit.attempt(username).allow) return "rate-limited";
	if (username === "john.doe" && password === "password123") return "success";
	return "wrong-password";
}

attemptLogin("john.doe", "wrongpass"); //-> "wrong-password"
attemptLogin("john.doe", "wrongpass2"); //-> "wrong-password"
attemptLogin("john.doe", "wrongpass"); //-> "wrong-password"
attemptLogin("john.doe", "password123"); //-> "rate-limited"
// wait 60 seconds
attemptLogin("john.doe", "password123"); //-> "success"

If you want to reset the rate limit after a successful login, call rateLimit.reset(username).

Documentation

Class: RateLimit

Rate limit

Static method: RateLimit.attempt(name, source, [attempts], [callback])

Make an attempt with a source ID

  • name string The name of the rate limit
  • source string Unique source identifier (e.g. username, IP, etc.)
  • attempts number The number of attempts to make. Default: 1
  • callback function Callback function. Default: undefined
  • Returns: AttemptResult
  • Throws: Error If the rate limit does not exist

Static method: RateLimit.check(name, source, [callback])

Check the attempt state for a source ID without decrementing the remaining attempts

  • name string The name of the rate limit
  • source string Unique source identifier (e.g. username, IP, etc.)
  • callback function Callback function. Default: undefined
  • Returns: AttemptResult
  • Throws: Error If the rate limit does not exist

Static method: RateLimit.clear(name)

Clear rate limit attempts storage. This is equivalent to resetting all rate limits.

  • name string The name of the rate limit
  • Returns: void
  • Throws: Error If the rate limit does not exist

Static method: RateLimit.create(name, limit, timeWindow)

Create a new rate limit

  • name string The name of the rate limit
  • limit number The number of attempts allowed per time window (e.g. 60)
  • timeWindow number The time window in seconds (e.g. 60)
  • Returns: RateLimit

Static method: RateLimit.delete(name)

Delete the rate limit instance. After it is deleted, it should not be used any further without constructing a new instance.

  • name string The name of the rate limit
  • Returns: void
  • Throws: Error If the rate limit does not exist

Static method: RateLimit.get(name)

Get a rate limit instance

Static method: RateLimit.reset(name, source)

Reset limit for a source ID. The storage entry will be deleted and a new one will be created on the next attempt.

  • name string The name of the rate limit
  • source string Unique source identifier (e.g. username, IP, etc.)
  • Returns: void
  • Throws: Error If the rate limit does not exist

Static method: RateLimit.setRemaining(name, source, remaining)

Set the remaining attempts for a source ID.

Warning: This is not recommended as the remaining attempts depend on the limit of the instance.

  • name string The name of the rate limit
  • source string Unique source identifier (e.g. username, IP, etc.)
  • remaining number The number of remaining attempts
  • Returns: void
  • Throws: Error If the rate limit does not exist

new RateLimit(name, limit, timeWindow)

Create a new rate limit

  • name string The name of the rate limit
  • limit number The number of attempts allowed per time window (e.g. 60)
  • timeWindow number The time window in seconds (e.g. 60)
  • Throws: Error If the rate limit already exists

rateLimit.attempt(source, [attempts], [callback])

Make an attempt with a source ID

rateLimit.check(source, [callback])

Check the attempt state for a source ID without decrementing the remaining attempts

rateLimit.clear()

Clear rate limit attempts storage. This is equivalent to resetting all rate limits.

rateLimit.delete()

Delete the rate limit instance. After it is deleted, it should not be used any further without constructing a new instance.

rateLimit.limit

The number of requests allowed per time window

rateLimit.name

Get rate limit name

rateLimit.reset(source)

Reset limit for a source ID. The storage entry will be deleted and a new one will be created on the next attempt.

  • source string Unique source identifier (e.g. username, IP, etc.)
  • Returns: void

rateLimit.setRemaining(source, remaining)

Set the remaining attempts for a source ID.

Warning: This is not recommended as the remaining attempts depend on the limit of the instance.

  • source string Unique source identifier (e.g. username, IP, etc.)
  • remaining number The number of remaining attempts
  • Returns: void

rateLimit.timeWindow

The time window in seconds (e.g. 60)

Interface: AttemptResult

The result from a rate limit attempt

attemptResult.limit

The number of requests this rate limit allows per time window

attemptResult.remaining

The number of requests remaining in the current time window

attemptResult.reset

The number of seconds until the current time window resets

attemptResult.rateLimit

The rate limit that this attempt was made on

attemptResult.allow

Whether this attempt should be allowed to proceed. If false, the attempt is rate limited.