CaptchaHub HCaptcha (英语)

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

安装

使用 pnpm 安装软件包 :

pnpm add @captchahub/core
pnpm add @captchahub/hcaptcha

特征

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

使用量

获取 Captcha 脚本

这个 getCaptchaScript 函数可用如下:

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 函数可用如下:

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 函数可用如下:

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能力整合到他们的网络应用中.

捐款

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

您可以使用 :

pnpm format

您可以使用 :

pnpm test