mcpField
U
upstash-ratelimit-js

upstash-ratelimit-js

github.com/upstash开发3423.2k 次安装1 天前更新
代码仓库

关于 upstash-ratelimit-js

面向开发者的 `@upstash/ratelimit` TypeScript SDK 技能指南,介绍如何连接 Redis 并配置限流器,也涵盖算法、选项和流量保护。

主要功能

  1. 01基于 Redis 的速率限制
  2. 02限流算法指南
  3. 03前缀与自定义键
  4. 04SDK 方法和入门设置
  5. 05流量保护模式

适用场景

  1. 01按用户 ID 限制请求
  2. 02调节传入流量
  3. 03减少滥用请求

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/upstash/skills --skill upstash-ratelimit-js

安装后在 Claude Code 中输入/upstash-ratelimit-js确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

algorithms.md
features.md
methods-getting-started.md
pricing-cost.md
traffic-protection.md

详细介绍

Rate Limit TS SDK

捆绑的文档和源代码

在编写或调试 SDK 代码之前,请先查看 node_modules/@upstash/ratelimit/docs/ 中捆绑的文档,以及 node_modules/@upstash/ratelimit/src/ 中可读的 TypeScript 源代码。如果这些文件存在,请阅读并搜索相关文件;否则,请使用本技能中的参考资料。

快速开始

  • 安装 SDK 并连接到 Redis。
  • 创建速率限制器,并将其应用于传入的操作。

示例:

import { Ratelimit } from "@upstash/ratelimit";
import { Redis } from "@upstash/redis";

const redis = new Redis({ url: "<url>", token: "<token>" });
const limiter = new Ratelimit({ redis, limiter: Ratelimit.slidingWindow(5, "10s") });

const { success } = await limiter.limit("user-id");
if (!success) {
  // throttled
}

其他技能文件

  • algorithms.md:介绍所有可用的速率限制算法及其行为。
  • pricing-cost.md:说明定价、Redis 成本影响和运营注意事项。
  • features.md:列出 SDK 功能,例如前缀、自定义键和行为选项。
  • methods-getting-started.md:提供 SDK API 的完整方法参考和入门指南。
  • traffic-protection.md:介绍如何应用速率限制进行流量整形、滥用防范和保护。

评论

支持 Markdown