# @absolutejs/rate-limit 中文文档

规范地址：https://npmcn.com/package/%40absolutejs/rate-limit/

版本：0\.8\.0
npm 元数据更新时间：2026-10-22T06:43:20.303Z
中文译文更新时间：2026-11-07T00:07:19.432Z
软件包许可：BSL-1\.1

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40absolutejs/rate-limit
原文对照：https://npmcn.com/package/%40absolutejs/rate-limit/?lang=original
项目主页：https://github.com/absolutejs/rate-limit
源码仓库：https://github.com/absolutejs/rate-limit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：737 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：elysia ^2\.0\.0-rc\.0
- 首次发布：2026-05-29T20:45:43.881Z
- 最新版本发布：2026-10-22T06:43:19.957Z
- 近 30 天下载量：2131（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

Bun + Elysia的一等2026票价限额. 默认的 GCRA (精确, O(1) 每个密钥的内存, 无边界效应—— 算法花纹使用), IETF 草稿 - 09 RatLimit - \* headers, IPv6/64 分组, X- Forwarded - For trust models, BigInt 纳米秒 TAT, 可插

## 安装

```sh
npm install @absolutejs/rate-limit
```

也可以使用：`pnpm add @absolutejs/rate-limit`、`yarn add @absolutejs/rate-limit`、`bun add @absolutejs/rate-limit`

## README

# @ absolutejs/ rate- 限制

头等舱,从-scratch出道,为 Bun + Elysia 的2026 速率限制. **GCRA 默认** (算法花纹使用——精确,每键有O(1)内存,无边界效应),, **IETF 第09号草案 `RateLimit-*` 页眉**, (中文(简体) ), **IPv6/64 分组**, (中文(简体) ), **`X-Forwarded-For` 信任模式**, (中文(简体) ), **Bigint 纳秒 TAT** (没有漂浮), 可插件商店(LRU in-memory bunded).

```ts
import { Elysia } from 'elysia';
import { rateLimit, gcra } from '@absolutejs/rate-limit';

new Elysia()
  .use(rateLimit({
    algorithm: gcra({ requestsPerPeriod: 100, periodMs: 60_000, burst: 20 }),
    key: 'ip',
    trustedProxies: 1, // single CDN/LB hop trusted
  }))
  .get('/', () => 'ok')
  .listen(3000);
```

## 为什么不直接利用现有的图书馆

爱丽西亚生态系统的领先者是射线飞/爱丽西亚-速率限. 用一个 符号桶在 a 以上 `Map` 带有 `setInterval` 清净相. 没关系,但每个 选择从2020年开始。 2026出自-scrach的回答是:

| 关切 | 别人做什么 | 我们做什么 |
| --- | --- | --- |
| **算法** | 托肯桶(再填入边界时短暂冲出) | **加纳** 默认。 准确的,没有边界效应,每个密钥一个 BigInt 状态. 手提桶和滑动窗口也捆绑着,只要你想. |
| **时间精确度** | `Date.now()` ms(从长生键上漂移) | **大英寸纳秒** 为GCRA TAT。 漂浮无所取. |
| **IPv6 请检查url=值 (帮助)** | 每128个(每个装置1个盖-a) `/64` 使用 N 设备的用户获得 N× 它们的盖) | **每64人组** 默认(RIR分配=一个用户). 相会相会. |
| **代理信任** | 信托 `X-Forwarded-For` 盲从或忽略它 | `trustedProxies: N` ——只尊重最后的N跳;默认情况下可防跳(`N=0`) (中文(简体) ). |
| **页眉** | `X-RateLimit-*` (遗产GitHub风格) | **IETF 第09号草案 `RateLimit-*` + 键 `RateLimit-Policy`** 默认。 遗产+ `both` 模式也可用. |
| **存储清理** | `setInterval` 扫描器(每个过程的计时器;迭代的锁定争议) | **懒 TTL** 检查时间。 无背景计时器 . |
| **热路** | 甚至在记忆存储器上同步 | **商店同步时同步**只有在必须时才会发出警报. |
| **CDN 页眉** | 仅 预算外 | 预算外 + `cf-connecting-ip` + 键 `fly-client-ip` + 键 `true-client-ip` + 键 `x-real-ip`。 。 。 . |

## 表面

### 爱丽西亚插件( E)`@absolutejs/rate-limit`(中文(简体) )

```ts
rateLimit({
  algorithm: gcra({ requestsPerPeriod: 100, periodMs: 60_000, burst: 20 }),
  store: memoryStore({ maxKeys: 100_000 }),

  // key — defaults to 'ip' (uses extractIp).
  key: 'ip',                                                   // built-in
  // key: 'authorization',                                       // built-in
  // key: (ctx) => ctx.request.headers.get('x-user') ?? null,    // custom

  trustedProxies: 1,         // honor only the last hop of XFF (typical: 1)
  ipv6Prefix: 64,            // group IPv6 by /64

  skip: (ctx) => ctx.request.headers.get('authorization') === ADMIN_TOKEN,

  headers: 'standard',       // 'standard' | 'legacy' | 'both' | false

  onLimit: (ctx, info) => new Response(JSON.stringify({
    ok: false,
    retryAfterSec: info.decision.retryAfterSec,
  }), { status: 429, headers: { 'Content-Type': 'application/json' } }),
})
```

### 算术( E)`@absolutejs/rate-limit/core`(中文(简体) )

```ts
import { gcra, tokenBucket, slidingWindow, memoryStore } from '@absolutejs/rate-limit/core';

const limiter = gcra({ requestsPerPeriod: 100, periodMs: 60_000, burst: 20 });
const store = memoryStore();
const decision = limiter.check(store, 'user-42', Date.now());
// → { allowed, limit, remaining, retryAfterSec, resetSec, policy }
```

对非 HTTP 速率限制直接使用核心 – WebSocket- message 速率 限制 排队 消费者节奏 人工智能呼叫配额.

### 存储接口

```ts
type Store = {
  update<T>(key: string, ttlMs: number, fn: (prev: T | null) => T): T | Promise<T>;
  delete?(key: string): void | Promise<void>;
  clear?(): void | Promise<void>;
};
```

执行 `update` 解剖(read-modify-write);其余为可选. 对于 Bun 正在处理中的使用 `memoryStore()`. 多审制 Bun 服务由 PostgreSQL 可以使用捆绑的耐用适配器:

```ts
import { SQL } from 'bun';
import { postgresStore } from '@absolutejs/rate-limit/postgres';

const store = postgresStore({
  sql: new SQL(process.env.DATABASE_URL),
  table: 'absolute_rate_limit_entries',
});
```

应用程序拥有表格迁移 。 这需要 `key text PRIMARY KEY`, (中文(简体) ), `value jsonb NOT NULL`, (中文(简体) ), `expires_at timestamp NOT NULL`,以及 `updated_at timestamp NOT NULL`。每个键 PostgreSQL 交易咨询锁 线性化复制更新,包括行前的第一次更新 已存在。 过期的行在下一次更新时被粗略地替换; `activeEntries()` 当前报告 `pruneExpired()` 页:1 为已丢弃的密钥进行范围化操作员清理 .

## 算法拾取器

-   **加纳** - 选这个 除非你有理由不选 准确,O(1)记忆, 无边界效应, BigInt 数学=无漂移。 桶可配置; 设置 `burst: 0` 为严格的节奏.
-   **脚桶** 当你特别想要"填满"时,就选这个 桶并让用户一举一动"的行为. 更干净的心理 最终用户模式.
-   **滑动窗口** ——选择这个,当顾客的故事是"你" 在最后M秒有N请求。" 这是一个近似可以 在重聚时低于~1位数,但它是最直观的 在状态页面上解释.

## 许可证

BSL 1.1对主机速率限制 / WAF / API 网关减速类(Cloudflare WAF + 速率限制,AWS WAF + API 网关减速类,Kong, Tyk, Imperva, Akamai, GCP Cloud Armor, Azure Front Door 速率限制, Upstash rate限制, Frece的API 网关减速类)有命名的例外. 见 [自由主义](https://npmcn.com/package/%40absolutejs/rate-limit/LICENSE). 更改日期: 4 从首次发布起; 更改许可证: Apache 2.0.

`sqlStore(client, table?)` 从 `@absolutejs/rate-limit/postgres` 支持主机管理 PostgreSQL 交易而不需要 Bun SQL 。 供应 `query(text, params) -> { rows }` 财务报告和审定财务报表 `transaction(callback)`。它的日记主机拥有的表格 `key text primary key`, (中文(简体) ), `value jsonb`, (中文(简体) ), `expires_at timestamptz`,以及 `updated_at timestamptz`。更新和删除共享 PostgreSQL 咨询锁。 现有 `postgresStore({ sql })` 现保留.

## 常见问题

### @absolutejs/rate-limit 是什么？

Bun \+ Elysia的一等2026票价限额\. 默认的 GCRA \(精确, O\(1\) 每个密钥的内存, 无边界效应—— 算法花纹使用\), IETF 草稿 - 09 RatLimit - \* headers, IPv6/64 分组, X- Forwarded - For trust models, BigInt 纳米秒 TAT, 可插

### 如何安装 @absolutejs/rate-limit？

在项目目录运行 npm install @absolutejs/rate-limit，或使用 pnpm add / yarn add / bun add。

### @absolutejs/rate-limit 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @absolutejs/rate-limit 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @absolutejs/rate-limit 可以商用吗？

@absolutejs/rate-limit 使用 BSL-1\.1 许可。声明的许可为 BSL-1\.1，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @absolutejs/rate-limit 的下载量有多少？

根据 npm 官方下载统计，@absolutejs/rate-limit 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,131 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @absolutejs/rate-limit 还在维护吗？

最新版本 0\.8\.0 发布于 2026/10/22（16 天前）；至今共发布 18 个版本，其中过去 12 个月发布了 18 个；首次发布于 2026/05/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。