# @glenstack/cf-workers-hcaptcha

> Verify a hCaptcha token from within a Cloudflare Worker

Latest version **1.0.0** (published 2020-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @glenstack/cf-workers-hcaptcha
pnpm add @glenstack/cf-workers-hcaptcha
yarn add @glenstack/cf-workers-hcaptcha
bun add @glenstack/cf-workers-hcaptcha
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-08-18 |
| First published | 2020-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 60 |
| Author | Greg Brimble |
| Maintainers | gregbrimble |

## Links

- npm: https://www.npmjs.com/package/@glenstack/cf-workers-hcaptcha
- Repository: https://github.com/glenstack/glenstack
- Homepage: https://github.com/glenstack/glenstack#readme
- Issues: https://github.com/glenstack/glenstack/tree/master/packages/cf-workers-hcaptcha
- npm.io page: https://npm.io/package/@glenstack/cf-workers-hcaptcha

## Recent versions

- 1.0.0 (latest) — 2020-08-18

## README

# Cloudflare Workers hCaptcha

Verify a [hCaptcha](https://www.hcaptcha.com/) token from within a [Cloudflare Worker](https://workers.cloudflare.com/).

## Installation

```sh
npm install --save @glenstack/cf-workers-hcaptcha
```

## Usage

```typescript
import { createVerifier } from "@glenstack/cf-workers-hcaptcha";

const verify = createVerifier("0x0000000000000000000000000000000000000000");

const handleRequest = async (request) => {
  try {
    const payload = await verify(request);
    return new Response("Verified!");
  } catch (e) {
    return new Response(`Could not verify hCaptcha token: ${e.message}`, {
      status: 401,
    });
  }
};

addEventListener("fetch", (event) => {
  const { request } = event;
  event.respondWith(handleRequest(request));
});
```

`createVerifier` takes a single parameter, the secret key used to verify tokens.

It returns a function which, in turn, takes two parameters:

1. The Request.
1. Optionally, an object with the optional parameters:

   - `tokenExtractor`: An asynchronous function which, when given a Request, returns the token to verify. This defaults to extracting `h-captcha-response` from the `formData` body.

It returns a Promise of the [the hCaptcha payload](https://docs.hcaptcha.com/#server) if the verification was successful, else throws an error with [a human-readable error message](https://docs.hcaptcha.com/#server).

---
_Source: https://npm.io/package/@glenstack/cf-workers-hcaptcha · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._