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

nuxthub-ratelimit

v1.0.4

Published

Rate limiting for Nuxt Hub

Downloads

632

Readme

NuxtHub Rate Limit

Add rate limits to your NuxtHub API routes to protect your application from abuse and ensure fair usage of your resources.

This module is specifically designed for NuxtHub and uses hubKV to store rate limit data, making it perfect for serverless environments.

By default, this module will add a rate limit to any requests to a /api endpoint.

Inspired by Nuxt Rate Limit

Features

  • 📚 Uses hubKV to store rate limit data
  • 🛑 Set rate limits per API route
  • 🕒 Returns seconds until reset
  • ⚡ Takes seconds to setup
  • 🧾 Response x-ratelimit headers

Prerequisites

  • A NuxtHub project with hubKV enabled. Add the following to your nuxt.config.ts:
export default defineNuxtConfig({
  hub: {
    kv: true,
  },
})

Quick Setup

  1. Add nuxthub-ratelimit dependency to your project
pnpm add -D nuxthub-ratelimit
yarn add --dev nuxthub-ratelimit
npm install --save-dev nuxthub-ratelimit
  1. Add nuxthub-ratelimit to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxthub-ratelimit'],
})

That's it! You can now use NuxtHub Rate Limit in your Nuxt app ✨

Options

| name | type | default | description | | --------------- | --------- | --------------------------------------------------------- | -------------------------------------------------------------------------- | | enabled | boolean | true | Enable/disable the rate limit module | | headers | boolean | true | Add x-ratelimit headers to response | | statusMessage | string | Too many requests. Please try again in :value: seconds. | Customize error message. :value: will be replaced by seconds until reset | | routes | object | {} | Add rate limits per route (see examples below) |

Important Note on NuxtHub KV TTL

NuxtHub KV has a minimum Time To Live (TTL) of 60 seconds. This means that the intervalSeconds in your rate limit configuration should be at least 60 seconds to ensure proper functionality.

Default Rate Limit

By default, we add a rate limit to all of your /api routes. You can override this setting by adding /api/* to the nuxtHubRateLimit routes in your nuxt.config.ts:

export default defineNuxtConfig({
  nuxtHubRateLimit: {
    routes: {
      '/api/*': {
        maxRequests: 100,
        intervalSeconds: 60, // Minimum 60 seconds due to NuxtHub KV TTL limitation
      },
    },
  },
})

Different limits per route

You can also add limits per route:

export default defineNuxtConfig({
  nuxtHubRateLimit: {
    routes: {
      '/api/hello': {
        maxRequests: 50,
        intervalSeconds: 60, // Minimum 60 seconds due to NuxtHub KV TTL limitation
      },
      '/api/goodbye': {
        maxRequests: 30,
        intervalSeconds: 120, // 2 minutes
      },
    },
  },
})

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License