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

@moeed/nestjs-rate-limiter

v1.0.0

Published

A Nest.js module for rate limiting using express-rate-limit

Downloads

5

Readme

Nest.js Rate Limiter Module

A simple and efficient rate limiting module for Nest.js applications. It leverages express-rate-limit to protect your application from abuse by limiting the number of requests that a client can make within a defined time window.

Installation

First, install the module using npm:

npm install @moeed/nestjs-rate-limiter --save

Make sure to also have express-rate-limit installed, as it is a peer dependency.

Usage

Import the RateLimiterModule into your root module and configure it using the register method:

import { RateLimitModule } from '@moeed/nestjs-rate-limiter';

@Module({
  imports: [
    RateLimiterModule.register({
      windowMs: 15 * 60 * 1000, // 15 minutes
      max: 100, // limit each IP to 100 requests per windowMs
    }),
    // ... other modules
  ],
})
export class AppModule {}

Custom Routes

You can specify custom routes to apply rate limiting by using the routes option:

RateLimiterModule.register({
  windowMs: 15 * 60 * 1000,
  max: 100,
  routes: [
    { path: '/api', method: RequestMethod.ALL },
    { path: '/auth/login', method: RequestMethod.POST },
  ],
})

Options

The following options can be used to configure the rate-limiting behavior:

  • windowMs: The duration in milliseconds to keep track of requests (default: 60000).
  • max: The maximum number of requests allowed within windowMs (default: 5).
  • routes: An optional array of custom routes to apply rate limiting.

See the express-rate-limit documentation for more options and details.

Features

  • Easy integration with existing Nest.js applications.
  • Extends express-rate-limit, allowing for a wide range of customization.
  • Global module availability.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page or open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you find this package useful, please consider starring the repository on GitHub or sharing it with your colleagues.