ratelimitapi
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

RateLimitAPI

npm version License: MIT GitHub Actions publish workflow status

This package is currently in early development and not ready for production use.

Features, API, and documentation are subject to change. We are actively working to stabilize the package for a production release.

Overview

RateLimitAPI is a powerful rate limiting middleware for APIs, it is currently under development. It provides a simple yet robust solution for implementing industry-standard rate limiting to protect your endpoints from abuse.

Features (Planned)

  • Easy-to-use middleware for popular frameworks
  • Flexible rate limit configuration
  • Customizable response formats for rate limit headers
  • Detailed analytics and monitoring
  • Protection against common abuse patterns

Installation

npm install ratelimitapi

or

yarn add ratelimitapi

Documentation

Full documentation will be available at RateLimitAPI.com upon official release.

Usage Preview

const rateLimitResponse = await isRateLimited(request, "your-api-token");
if (rateLimitResponse) {
return rateLimitResponse; // Return the 429 response if rate-limited
}
// Continue with normal request handling if not rate-limited

License

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

Stay Updated

  • Star our GitHub repository
  • Follow our progress on Twitter (coming soon)
  • Join our community Discord (coming soon)

Contact

For more information, please visit RateLimitAPI.com when it's available.

Package Sidebar

Install

npm i ratelimitapi

Weekly Downloads

6

Version

0.1.3

License

MIT

Unpacked Size

8.42 kB

Total Files

5

Last publish

Collaborators

  • ratelimitapi-team