verify-hcaptcha
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

verify-hcaptcha

Build status Coverage jsDocs.io Language npm bundle size npm License

A no dependencies, fully typed library to verify hCaptcha tokens submitted by users when solving CAPTCHA challenges.

Note: this is an unofficial library; we are not affiliated with hCaptcha.com

Features

  • No dependencies
  • Fully typed API and response data
  • Well documented and tested

API & Package Info

Install

Using npm:

npm i verify-hcaptcha

Using yarn:

yarn add verify-hcaptcha

Usage Examples

Verify a token submitted by a user:

import { verifyHcaptchaToken } from 'verify-hcaptcha';

(async () => {
    const result = await verifyHcaptchaToken({
      token: "USER-SUBMITTED-RESPONSE-TOKEN",
      secretKey: "YOUR-SECRET-KEY",
      siteKey: "YOUR-SITE-KEY",
    });

    if (result.success) {
      console.log("User is human");
    } else {
      console.log("User is robot");
    }
})();

Verify a token submitted by a user and get the raw response from hCaptcha:

import { rawVerifyHcaptchaToken } from 'verify-hcaptcha';

(async () => {
    const result = await rawVerifyHcaptchaToken({
      token: "USER-SUBMITTED-RESPONSE-TOKEN",
      secretKey: "YOUR-SECRET-KEY",
      siteKey: "YOUR-SITE-KEY",
    });

    if (result.success) {
      console.log("User is human");
    } else {
      console.log("User is robot");
    }
})();

License

MIT License

Copyright (c) 2021 Edoardo Scibona

See LICENSE file.

Package Sidebar

Install

npm i verify-hcaptcha

Weekly Downloads

145

Version

1.0.0

License

MIT

Unpacked Size

252 kB

Total Files

16

Last publish

Collaborators

  • velut