upstash/ratelimit-js / skills
upstash-ratelimit-ts
VerifiedLightweight 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.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 1.2 KB |
| algorithms.md | markdown | 2.7 KB |
| features.md | markdown | 3.1 KB |
| methods-getting-started.md | markdown | 1.9 KB |
| pricing-cost.md | markdown | 4.6 KB |
| traffic-protection.md | markdown | 2.3 KB |
methods-getting-started.md
View on GitHub# Upstash Ratelimit Methods (TypeScript)
This document provides a focused, practical reference for all Ratelimit methods. Each section includes direct examples, usage patterns, and common pitfalls.
## limit
Primary method for checking and consuming tokens.
```ts
const { success, remaining, reset, reason, pending } = await ratelimit.limit(
identifier,
{
rate: 2, // optional: consume N tokens
ip: req.ip, // optional: used for deny‑list checks
userAgent: ua, // optional
country: geo?.country,
}
);
if (!success) return "blocked";
// In Cloudflare/Vercel Edge, flush async work
context.waitUntil(pending);
```
Notes:
- `rate` lets a request consume more than 1 token.
- `reason` can be: `timeout`, `cacheBlock`, `denyList`, or undefined.
- When analytics or MultiRegion is enabled, **always handle `pending`** in serverless environments.
## blockUntilReady
Waits for a request to become allowed instead of rejecting immediately.
```ts
const { success } = await ratelimit.blockUntilReady("id", 30_000);
if (!success) return "still blocked after timeout";
```
## resetUsedTokens
Clears the state for an identifier.
```ts
await ratelimit.resetUsedTokens("user123");
```
Useful when granting temporary resets or admin overrides.
## getRemaining
Read-only view of remaining quota.
```ts
const { remaining, reset } = await ratelimit.getRemaining("user123");
```
Common use cases:
- Dashboard queries
- Showing users their remaining quota
## setDynamicLimit
Overrides the global limit at runtime.
```ts
await ratelimit.setDynamicLimit({ limit: 5 }); // set
await ratelimit.setDynamicLimit({ limit: false }); // remove
```
Notes:
- Requires `dynamicLimits: true` in constructor.
- Applies to all future rate checks.
## getDynamicLimit
Fetch the currently active dynamic limit.
```ts
const { dynamicLimit } = await ratelimit.getDynamicLimit();
```
Returns `null` when no override is active.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |