用途:用于在 TypeScript 项目中通过 Upstash Redis 实现请求速率限制,属于轻量指引类资料,帮助完成 SDK 的安装、连接与基础接入。
主要能力:文档给出快速开始流程:安装 SDK 并连接 Redis,创建限流器后应用到传入操作。基础示例使用滑动窗口算法(slidingWindow),以标识(如 user-id)作为限流键,返回 success 判断是否被限流。
使用方式:示例从 @upstash/ratelimit 引入 Ratelimit,从 @upstash/redis 引入 Redis,用 url 与 token 构造 Redis 客户端,再通过 new Ratelimit({ redis, limiter: Ratelimit.slidingWindow(5, "10s") }) 创建限流器,调用 await limiter.limit("user-id") 获取结果,success 为 false 表示已被节流。
其他文档:algorithms.md 介绍可用限流算法及行为;pricing-cost.md 说明计费、Redis 成本影响与运维考量;features.md 列出前缀、自定义键及行为选项等特性;methods-getting-started.md 提供完整 API 方法参考与入门指南;traffic-protection.md 提供流量整形、滥用防护与保护模式的实践建议。
适用场景:需要对接口或操作做速率控制、防滥用与流量保护的 TypeScript 服务。
限制:具体算法清单、价格数值、特性细节与完整方法签名需查阅对应文档,本资料未提供;具体安装命令与示例中占位符(url、token)的实际取值暂未提供。