express-rate-limit

v7.5.0

Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset. For more information about how to use this package see README

Latest version published 7 days ago

License: MIT

NPM

GitHub

Package Health Score

91 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
7.5.0	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.4.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.11.2	\|	09/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.5.1	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.4.1	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Key ecosystem project

Weekly Downloads (1,140,014)

GitHub Stars: 2.93K
Forks: 226
Contributors: 70

Direct Usage Popularity

The npm package express-rate-limit receives a total of 1,140,014 downloads a week. As such, we scored express-rate-limit popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package express-rate-limit, we found that it has been starred 2,933 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 70
Funding: Yes

With more than 10 contributors for the express-rate-limit repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like express-rate-limit is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 6
Open PR: 1
Last Release: 7 days ago
Last Commit: 2 months ago

Further analysis of the maintenance status of express-rate-limit based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that express-rate-limit demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 16

Age: 10 years
Dependencies: 0 Direct
Versions: 111
Install Size: 124 kB
Dist-tags: 4
# of Files: 9
Maintainers: 2
TS Typings: Yes

express-rate-limit has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use express-rate-limit?

To help you get started, we've collected the most common ways that express-rate-limit is being used within popular public projects.

autoai-org / AID / components / discovery / src / main.ts View on Github

async function bootstrap() {
  if (config.MONGO_URI==="") {
    console.error("[db]: connection string is undefined!")
  } else {
    console.info("[db]:connecting to " + config.MONGO_URI)
    const app = await NestFactory.create(AppModule);
    await setupAdminPanel(app);
    app.use(helmet());
    app.use(
      rateLimit({
        windowMs: 60 * 1000, // 15 minutes
        max: 100, // limit each IP to 100 requests per windowMs
      }),
    );
    app.setBaseViewsDir(join(__dirname, '..', 'src', 'views'));
    app.setViewEngine('hbs');
    const options = new DocumentBuilder()
      .setTitle('AID Discovery')
      .setDescription('The AID Discovery API')
      .setVersion('0.0.1')
      .addTag('Model')
      .addTag('User')
      .addTag('Extension')
      .build();
    const document = SwaggerModule.createDocument(app, options);
    SwaggerModule.setup('api', app, document);

View more ways to use express-rate-limit

`express-rate-limit`

Basic rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset. Plays nice with express-slow-down and ratelimit-header-parser.

Usage

The full documentation is available on-line.

import { rateLimit } from 'express-rate-limit'

const limiter = rateLimit({
	windowMs: 15 * 60 * 1000, // 15 minutes
	limit: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes).
	standardHeaders: 'draft-8', // draft-6: `RateLimit-*` headers; draft-7 &amp; draft-8: combined `RateLimit` header
	legacyHeaders: false, // Disable the `X-RateLimit-*` headers.
	// store: ... , // Redis, Memcached, etc. See below.
})

// Apply the rate limiting middleware to all requests.
app.use(limiter)

Data Stores

The rate limiter comes with a built-in memory store, and supports a variety of external data stores.

Configuration

All function options may be async. Click the name for additional info and default values.

Option	Type	Remarks
`windowMs`	`number`	How long to remember requests for, in milliseconds.
`limit`	`number` \| `function`	How many requests to allow.
`message`	`string` \| `json` \| `function`	Response to return after limit is reached.
`statusCode`	`number`	HTTP status code after limit is reached (default is 429).
`handler`	`function`	Function to run after limit is reached (overrides `message` and `statusCode` settings, if set).
`legacyHeaders`	`boolean`	Enable the `X-Rate-Limit` header.
`standardHeaders`	`'draft-6'` \| `'draft-7'` \| `'draft-8'`	Enable the `Ratelimit` header.
`identifier`	`string` \| `function`	Name associated with the quota policy enforced by this rate limiter.
`store`	`Store`	Use a custom store to share hit counts across multiple nodes.
`passOnStoreError`	`boolean`	Allow (`true`) or block (`false`, default) traffic if the store becomes unavailable.
`keyGenerator`	`function`	Identify users (defaults to IP address).
`requestPropertyName`	`string`	Add rate limit info to the `req` object.
`skip`	`function`	Return `true` to bypass the limiter for the given request.
`skipSuccessfulRequests`	`boolean`	Uncount 1xx/2xx/3xx responses.
`skipFailedRequests`	`boolean`	Uncount 4xx/5xx responses.
`requestWasSuccessful`	`function`	Used by `skipSuccessfulRequests` and `skipFailedRequests`.
`validate`	`boolean` \| `object`	Enable or disable built-in validation checks.

Thank You

Sponsored by Zuplo a fully-managed API Gateway for developers. Add dynamic rate-limiting, authentication and more to any API in minutes. Learn more at zuplo.com

Thanks to Mintlify for hosting the documentation at express-rate-limit.mintlify.app

Finally, thank you to everyone who's contributed to this project in any way! 🫶

Issues and Contributing

If you encounter a bug or want to see something added/changed, please go ahead and open an issue! If you need help with something, feel free to start a discussion!

If you wish to contribute to the library, thanks! First, please read the contributing guide. Then you can pick up any issue and fix/implement it!

License

express-rate-limit development dependencies

FAQs

What is express-rate-limit?

Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as p... Visit Snyk Advisor to see a full health score report for express-rate-limit, including popularity, security, maintenance & community analysis.

Is express-rate-limit popular?

The npm package express-rate-limit receives a total of 1,140,014 weekly downloads. As such, express-rate-limit popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is express-rate-limit well maintained?

We found that express-rate-limit demonstrated a healthy version release cadence and project activity. It has a community of 70 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is express-rate-limit safe to use?

The npm package express-rate-limit was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 01:03 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,140,014)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use express-rate-limit?

express-rate-limit

Usage

Data Stores

Configuration

Thank You

Issues and Contributing

License

express-rate-limit development dependencies

FAQs

What is express-rate-limit?

Is express-rate-limit popular?

Is express-rate-limit well maintained?

Is express-rate-limit safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`express-rate-limit`