Close Menu

captchaface

Thank you for visiting the documentation page for CaptchaFace, a powerful and easy-to-use library for implementing CAPTCHA functionality in your applications. This guide will provide you with a comprehensive understanding of the features and functionality offered by CaptchaFace.

Installation

To install CaptchaFace, follow these steps:

  1. Open your terminal or command prompt.
  2. Navigate to the root directory of your project.
  3. Run the following command to install CaptchaFace:
npm install captchaface

Getting Started

Before diving into the usage details, here’s a quick overview of how to get started with CaptchaFace:

  1. Import the CaptchaFace library into your project.
  2. Create an instance of CaptchaFace.
  3. Generate a CAPTCHA image using the generateCaptcha() method.
  4. Display the CAPTCHA image to the user.
  5. Validate the user input using the validateCaptcha() method.

Usage Examples

Importing the Library

// Import CaptchaFace library
const CaptchaFace = require('captchaface');

Creating CaptchaFace Instance

// Create an instance of CaptchaFace
const captcha = new CaptchaFace();

Generating CAPTCHA

// Generate a CAPTCHA image
const captchaImage = captcha.generateCaptcha();

Displaying CAPTCHA

To display the CAPTCHA image to the user, you can use the following HTML code:

<img src="data:image/png;base64,{{captchaImage}}" alt="CAPTCHA Image">

Validating CAPTCHA

// Validate user input
const userInput = 'abcde'; // Replace with actual user input
const isValid = captcha.validateCaptcha(userInput);
if (isValid) {
  console.log('CAPTCHA is valid!');
} else {
  console.log('CAPTCHA is invalid.');
}

Further Customization

CaptchaFace provides various options to customize the appearance and behavior of the generated CAPTCHAs. Here are a few examples:

Custom Length

// Set CAPTCHA length to 6 (default is 5)
captcha.setLength(6);

Custom Background Color

// Set CAPTCHA background color to light gray
captcha.setBackgroundColor('#f2f2f2');

Custom Text Color

// Set CAPTCHA text color to red
captcha.setTextColor('red');

Conclusion

CaptchaFace simplifies the implementation of CAPTCHA functionality in your applications. With its easy-to-use methods and customizable options, you can enhance the security of user interactions and protect your systems from automated attacks. If you have any further questions or need assistance, please don’t hesitate to reach out to our support team.