---

name: ratelimit-ts description: Lightweight guidance for using the Redis Rate Limit TypeScript SDK, including setup steps, basic usage, and pointers to advanced algorithm, features, pricing, and traffic‑protection docs.

Rate Limit TS SDK

Quick Start

• Install the SDK and connect to Redis.
• Create a rate limiter and apply it to incoming operations.

Example:

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
}

Other Skill Files

• algorithms.md: Describes all available rate‑limiting algorithms and how they behave.
• pricing-cost.md: Explains pricing, Redis cost implications, and operational considerations.
• features.md: Lists SDK features such as prefixes, custom keys, and behavioral options.
• methods-getting-started.md: Full method reference for the SDK's API and getting started guide.
• traffic-protection.md: Guidance on applying rate limiting for traffic shaping, abuse prevention, and protection patterns.