upstash-ratelimit-js

レート制限 TS SDK

バンドルされたドキュメントとソース

SDK コードを作成またはデバッグする前に、バンドルされたドキュメントについては node_modules/@upstash/ratelimit/docs/ を、読みやすい TypeScript ソースについては node_modules/@upstash/ratelimit/src/ を確認してください。該当するファイルがある場合は読み、検索してください。ない場合は、このスキル内のリファレンスを使用してください。

クイックスタート

• 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：トラフィックシェーピング、不正利用の防止、保護パターンにレート制限を適用する方法を説明します。