npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-recaptcha-v3

v1.0.34

Published

A Node.js library for verifying Google reCAPTCHA v3 tokens in your applications.

Downloads

2,318

Readme

node-recaptcha-v3

An open-source Node.js library to support verifying Google reCAPTCHA V3.

You can see an example here

Table of Contents

Installation

You can install the package using npm:

npm install node-recaptcha-v3

Usage

To use the library, you need to create an instance of the ReCaptchaV3 class with your secret key. After that, you can use the verify middleware in your Express.js routes.

Example

import express from 'express';
import ReCaptchaV3 from 'node-recaptcha-v3';

const app = express();
const reCaptchaV3 = new ReCaptchaV3({ secretKey: 'YOUR_SECRET_KEY' });

app.use(express.json());

app.post('/verify', reCaptchaV3.verify(0.5), (req, res) => {
    res.send({ score: req.reCaptchaV3Score });
});

app.listen(3000, () => {
    console.log('Server is running on port 3000');
});

Creating and Sending Token

  • Install reCAPTCHA: Register your site at Google reCAPTCHA to obtain your site key.
  • Generate Token: Use the site key in your JavaScript to create a token when the user submits a form:
<script src="https://www.google.com/recaptcha/api.js?render=YOUR_SITE_KEY"></script>
<script>
    grecaptcha.ready(function () {
        grecaptcha.execute('YOUR_SITE_KEY', { action: 'submit' }).then(function (token) {
            // Send the token to the server via body or header
            fetch('/verify', {
                method: 'POST',
                headers: {
                    'recaptcha-v3-token': token // or send in the body
                },
                body: JSON.stringify({ reCaptchaV3Token: token })
            });
        });
    });
</script>

Middleware of the Server

The middleware accepts the token via body or header:

  • Body: reCaptchaV3Token
  • Header: re-captcha-v3-token

API Reference

reCAPTCHA

  • Constructor: new ReCaptchaV3(options)

    • options (Object): An object containing the configuration options.
      • secretKey (String): Your reCAPTCHA secret key.
  • Method: verify(threshold)

    • threshold (Number): The score threshold (0.0 - 1.0). Requests with scores below this threshold will be rejected.

Examples

Here are some common scenarios you can implement with the library:

  • Verify reCAPTCHA Score: Ensure that the request meets the score threshold for further processing.
  • Custom Threshold: You can set a custom threshold for different routes based on your requirements.

License

This project is licensed under the MIT License. See the LICENSE file for details.