# @friendlycaptcha/sdk 中文文档

规范地址：https://npmcn.com/package/%40friendlycaptcha/sdk/

版本：1\.1\.5
npm 元数据更新时间：2026-11-11T13:41:32.605Z
中文译文更新时间：2026-11-15T14:11:40.195Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40friendlycaptcha/sdk
原文对照：https://npmcn.com/package/%40friendlycaptcha/sdk/?lang=original
项目主页：https://github.com/FriendlyCaptcha/friendly-captcha-sdk#readme
源码仓库：https://github.com/FriendlyCaptcha/friendly-captcha-sdk

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

- 包体积（解压后）：2.1 MB，468 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-12-08T16:03:39.639Z
- 最新版本发布：2026-11-11T13:41:32.079Z
- 近 30 天下载量：242197（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 18 个）

## 中文简介

友好卡普查 v2 浏览器 SDK

## 安装

```sh
npm install @friendlycaptcha/sdk
```

也可以使用：`pnpm add @friendlycaptcha/sdk`、`yarn add @friendlycaptcha/sdk`、`bun add @friendlycaptcha/sdk`

## README

# 友好的卡普查 SDK

[![NPM Version badge](https://img.shields.io/npm/v/%40friendlycaptcha/sdk)](https://www.npmjs.com/package/@friendlycaptcha/sdk)

用于将 Friendly Captcha v2 整合到您的网站上的 SDK .

这是您网站上运行的代码, 插入了 Captcha 部件 .

> 这是SDK的 **友好的 Captcha v2 仅限**如果你正在寻找v1 SDK,你可以找到 [这里](https://github.com/friendlycaptcha/friendly-challenge)。 。 。 .

## 安装

```shell
# using npm
npm install @friendlycaptcha/sdk

# using yarn
yarn add @friendlycaptcha/sdk
```

你可以在图书馆里使用它.

```js
import { FriendlyCaptchaSDK } from "@friendlycaptcha/sdk"

// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();
```

```js
// HTML element that you want to mount the widget under.
const mount = document.querySelector("#my-widget-mount");

// Create the widget
const widget = sdk.createWidget({
    element: mount,
    sitekey: "<your sitekey>"
});
```

### 常见JS

你也可以这样 `require` 如果你的环境使用普通JS的话.

```js
var { FriendlyCaptchaSDK } = require("@friendlycaptcha/sdk");

// Re-use this SDK if you are creating multiple widgets.
const sdk = new FriendlyCaptchaSDK();
```

## 文档

这些文件可见于我们 [开发者枢纽](https://developer.friendlycaptcha.com/docs/v2/sdk/),则 [_开始_ 指南](https://developer.friendlycaptcha.com/docs/v2/getting-started/)。 。 。 .

## 发展

如果您想要开发 SDK 本身, 下列命令是有用的

```shell
# install dependencies 
npm install

# minimal build
npm run build

# build for distribution (also builds docs)
npm run build:dist

# run the basic unit tests
npm run test
```

### 浏览器兼容性

SDK支持非常旧的浏览器(包括IE11). 这个 `.compat` 捆绑与 Babel 转接 并获得多填充 `src/polyfill/` (单位:千美元)`Promise`, (中文(简体) ), `Map`, (中文(简体) ), `Set`, (中文(简体) ), `WeakMap` 财务报告和审定财务报表 `WeakSet`),但Babel不转接发电机或 `async` 函数,而不填充任何其他API。 运行相容linter以查找语言特性和 API 来避免 :

```shell
npm run lint:compat
```

规矩是存在的 [`lint-compat.config.mjs`](https://npmcn.com/package/%40friendlycaptcha/sdk/lint-compat.config.mjs). 沉默一种蓄意使用,例如经过特征检查的,使用 `// compat-ignore: reason` 在相同或上行上注释.

### 测试

我们把更适当的端到端测试纳入 [**测试**](https://npmcn.com/package/%40friendlycaptcha/sdk/sdktest/) 工具文件夹.

### 更新 docusaurus SDK 参考文件

我们自动生成标记下的文件,并将它们翻译为对Docuraurus有效的格式的文件。 然后您需要手动更新文件, 删除旧文件并添加新文件 。 像这样:

```shell
 rm -rf ../friendly-docs/docs/sdk/reference && mkdir ../friendly-docs/docs/sdk/reference && cp -r ./dist/docs/docusaurus/ ../friendly-docs/docs/sdk/reference/
```

### 添加许可证头

```shell
# print those files that would be changed
npm run license-check-and-add -- check

# add the headers
npm run license-check-and-add -- add
```

## 许可证

这是免费的软件,你可以按照以下条款重新分配和/或修改: [Mozilla 公共许可版本 2.0](https://npmcn.com/package/%40friendlycaptcha/sdk/LICENSE)。 。 。 .

## 捐款

欢迎捐款.

在我们接受你的贡献之前... ...你需要签下我们 [CLA(捐助者许可证协议)](https://cla-assistant.io/FriendlyCaptcha/friendly-captcha-sdk)。 。 。 .

## 常见问题

### @friendlycaptcha/sdk 是什么？

友好卡普查 v2 浏览器 SDK

### 如何安装 @friendlycaptcha/sdk？

在项目目录运行 npm install @friendlycaptcha/sdk，或使用 pnpm add / yarn add / bun add。

### @friendlycaptcha/sdk 支持 TypeScript 吗？

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

### @friendlycaptcha/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @friendlycaptcha/sdk 可以商用吗？

@friendlycaptcha/sdk 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @friendlycaptcha/sdk 的下载量有多少？

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

### @friendlycaptcha/sdk 还在维护吗？

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