# @captchahub/hcaptcha 中文文档

规范地址：https://npmcn.com/package/%40captchahub/hcaptcha/

版本：1\.0\.12
npm 元数据更新时间：2026-08-28T23:53:59.276Z
中文译文更新时间：2026-11-09T05:35:30.272Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40captchahub/hcaptcha
原文对照：https://npmcn.com/package/%40captchahub/hcaptcha/?lang=original

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

- 包体积（解压后）：63.9 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2024-11-23T19:14:26.556Z
- 最新版本发布：2026-08-28T23:53:59.092Z
- 近 30 天下载量：6459（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 4 个）

## 中文简介

**CaptchaHub HCaptcha是一个TypeScript库,提供与HCaptcha服务的集成,允许在您的应用程序中实现无缝Captcha执行.** 此软件包扩展了 CaptchaHub 的核心功能, 支持 HCaptcha 作为一种

## 安装

```sh
npm install @captchahub/hcaptcha
```

也可以使用：`pnpm add @captchahub/hcaptcha`、`yarn add @captchahub/hcaptcha`、`bun add @captchahub/hcaptcha`

## README

# CaptchaHub HCaptcha (英语)

**CaptchaHub HCaptcha是一个TypeScript库,提供与HCaptcha服务的集成,允许在您的应用程序中实现无缝Captcha执行.** 这个软件包扩展了CaptchaHub的核心功能,支持作为Captcha提供者的HCaptcha.

## 安装

使用 pnpm 安装软件包 :

```bash
pnpm add @captchahub/core
pnpm add @captchahub/hcaptcha
```

## 特征

-   **用户隐私**:HCaptcha的设计中考虑到用户隐私.
-   **可自定义**:轻松地自定义出卡布特克的外观和行为.
-   **需要核心软件包**: 此软件包需要 `@captchahub/core` 用于功能的软件包.

## 使用量

### 获取 Captcha 脚本

这个 `getCaptchaScript` 函数可用如下:

```typescript
import { getCaptchaScript } from '@captchahub/core';
// Import the provider package to trigger self-registration
import '@captchahub/hcaptcha';

const config = {
    CAPTCHA_PROVIDER: 'hcaptcha',
    HCAPTCHA_SITE_KEY: process.env.HCAPTCHA_SITE_KEY, // Your HCaptcha site key
};

const CaptchaComponent = () => {
    const CaptchaScript = getCaptchaScript(config);

    return (
        <div>
            <CaptchaScript />
            {/* Additional form elements */}
        </div>
    );
};
```

### 获取 Captcha 窗体元素

这个 `getCaptchaFormElement` 函数可用如下:

```typescript
import { getCaptchaFormElement } from '@captchahub/core';
// Import the provider package to trigger self-registration
import '@captchahub/hcaptcha';

const config = {
    CAPTCHA_PROVIDER: 'hcaptcha',
    HCAPTCHA_SITE_KEY: process.env.HCAPTCHA_SITE_KEY, // Your HCaptcha site key
};

const CaptchaFormComponent = () => {
    const CaptchaFormElement = getCaptchaFormElement(config);

    return (
        <div>
            <CaptchaFormElement />
            {/* Additional form elements */}
        </div>
    );
};
```

### 正在验证 Captcha

这个 `verifyCaptcha` 函数可用如下:

```typescript
import { verifyCaptcha } from '@captchahub/core';
// Import the provider package to trigger self-registration
import '@captchahub/hcaptcha';

const config = {
    CAPTCHA_PROVIDER: 'hcaptcha',
    HCAPTCHA_SECRET_KEY: process.env.HCAPTCHA_SECRET_KEY, // Your HCaptcha secret key
};

const formFieldValues = {
    // Your form field values that need to be verified
};

const isValid = await verifyCaptcha(formFieldValues, config);
if (isValid) {
    console.log('Captcha verified successfully!');
} else {
    console.error('Captcha verification failed.');
}
```

### 配置

HCaptcha 提供者的配置可以在创建 Captcha 实例时被传递到工厂的配置对象中定义. 配置对象必须包含 `CAPTCHA_PROVIDER` 属性以指定要使用的 Captcha 提供者。 此外,您还需要提供 `HCAPTCHA_SITE_KEY` 财务报告和审定财务报表 `HCAPTCHA_SECRET_KEY` 用于适当的功能.

## 扩展性

这个 `@captchahub/hcaptcha` 软件包的设计可扩展。 您可以通过执行 `CaptchaInterface`。这使得您可以在未来为额外的cabtcha服务添加支持.

## 理由

这个 `@captchahub/hcaptcha` 软件包旨在提供与HCaptcha服务的集成,用于管理TypeScript应用程序中的Captcha工作流程. 通过使用核心软件包,开发者可以轻松地将HCaptcha能力整合到他们的网络应用中.

## 捐款

欢迎捐款! 请随意将这个项目叉出并提交拉动请求. 在提交之前,请确保您的代码通过所有起伏和单元测试.

您可以使用 :

```bash
pnpm format
```

您可以使用 :

```bash
pnpm test
```

## 常见问题

### @captchahub/hcaptcha 是什么？

CaptchaHub HCaptcha是一个TypeScript库,提供与HCaptcha服务的集成,允许在您的应用程序中实现无缝Captcha执行\. 此软件包扩展了 CaptchaHub 的核心功能, 支持 HCaptcha 作为一种

### 如何安装 @captchahub/hcaptcha？

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

### @captchahub/hcaptcha 支持 TypeScript 吗？

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

### @captchahub/hcaptcha 支持 ESM 还是 CommonJS？

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

### @captchahub/hcaptcha 可以商用吗？

@captchahub/hcaptcha 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @captchahub/hcaptcha 的下载量有多少？

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

### @captchahub/hcaptcha 还在维护吗？

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