Arcjet - JS SDK

npm 徽章

[Arcjet][arcjet] 帮助开发者用几行代码就能保护他们的应用程序。实现速率限制、机器人保护、电子邮件验证以及防御常见攻击。

这是包含各种 [Arcjet][arcjet] JS 开源包的单一代码仓库。

快速开始

使用 Bun？ 使用 [@arcjet/bun][npm-bun] 包，参考我们的 [Bun 快速开始指南][bun-quick-start]。
使用 Next.js？ 使用 [@arcjet/next][npm-next] 包，参考我们的 [Next.js 快速开始指南][next-quick-start]。
使用 Node.js？ 使用 [@arcjet/node][npm-node] 包，参考我们的 [Node.js 快速开始指南][node-quick-start]。
使用 SvelteKit？ 使用 [@arcjet/sveltekit][npm-sveltekit] 包，参考我们的 [SvelteKit 快速开始指南][sveltekit-quick-start]。

获取帮助

[加入我们的 Discord 服务器][discord-invite] 或 [联系我们寻求支持][support]。

示例

示例应用

在 [https://example.arcjet.com][example-url] 尝试受 Arcjet 保护的实时应用（[源代码][example-source]）。

使用方法

阅读 [docs.arcjet.com][arcjet-docs] 上的文档。

Next.js 速率限制示例

以下 [Arcjet 速率限制][rate-limit-concepts-docs] 示例对一个路由应用了令牌桶速率限制规则，我们根据用户 ID 识别用户，例如在用户登录时。桶的最大容量配置为 10 个令牌，每 10 秒补充 5 个令牌。每个请求消耗 5 个令牌。

详情请参阅 [Arcjet Next.js 速率限制文档][next-rate-limit-quick-start]。

import arcjet, { tokenBucket } from "@arcjet/next";
import { NextResponse } from "next/server";

const aj = arcjet({
  key: process.env.ARCJET_KEY!, // 从 https://app.arcjet.com 获取您的站点密钥
  rules: [
    // 创建一个令牌桶速率限制。支持其他算法。
    tokenBucket({
      mode: "LIVE", // 将阻止请求。使用 "DRY_RUN" 仅记录日志
      characteristics: ["userId"], // 通过自定义用户 ID 跟踪请求
      refillRate: 5, // 每个间隔补充 5 个令牌
      interval: 10, // 每 10 秒补充一次
      capacity: 10, // 桶的最大容量为 10 个令牌
    }),
  ],
});

export async function GET(req: Request) {
  const userId = "user123"; // 替换为您的已认证用户 ID
  const decision = await aj.protect(req, { userId, requested: 5 }); // 从桶中扣除 5 个令牌
  console.log("Arcjet 决策", decision);

  if (decision.isDenied()) {
    return NextResponse.json(
      { error: "请求过多", reason: decision.reason },
      { status: 429 },
    );
  }

  return NextResponse.json({ message: "你好，世界" });
}

Node.js 机器人保护示例

以下 [Arcjet 机器人保护][bot-protection-concepts-docs] 示例将对所有确定为自动化的客户端请求返回 403 禁止访问响应。

详情请参阅 [Arcjet Node.js 机器人保护文档][node-bot-quick-start]。

import arcjet, { detectBot } from "@arcjet/node";
import http from "node:http";
const aj = arcjet({
  key: process.env.ARCJET_KEY!, // 从 https://app.arcjet.com 获取你的站点密钥
  rules: [
    detectBot({
      mode: "LIVE", // 将阻止请求。使用 "DRY_RUN" 仅记录日志
      block: ["AUTOMATED"], // 阻止所有自动化客户端
    }),
  ],
});

const server = http.createServer(async function (
  req: http.IncomingMessage,
  res: http.ServerResponse,
) {
  const decision = await aj.protect(req);
  console.log("Arcjet 决策", decision);

  if (decision.isDenied()) {
    res.writeHead(403, { "Content-Type": "application/json" });
    res.end(JSON.stringify({ error: "禁止访问" }));
  } else {
    res.writeHead(200, { "Content-Type": "application/json" });
    res.end(JSON.stringify({ message: "你好，世界" }));
  }
});

server.listen(8000);