# captcha-generator-md

> Generates captcha image from string

Latest version **1.0.0** (published 2023-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install captcha-generator-md
pnpm add captcha-generator-md
yarn add captcha-generator-md
bun add captcha-generator-md
```

## 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 | 2023-08-21 |
| First published | 2023-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Diogo Mealha |
| Maintainers | diogomealha |
| Keywords | Captcha |

## Links

- npm: https://www.npmjs.com/package/captcha-generator-md
- Repository: https://github.com/diogoMealha/captcha-generator
- Homepage: https://github.com/diogoMealha/captcha-generator#readme
- Issues: https://github.com/diogoMealha/captcha-generator/issues
- npm.io page: https://npm.io/package/captcha-generator-md

## Dependencies (1)

- [jimp](https://npm.io/package/jimp.md) ^0.22.10

## Recent versions

- 1.0.0 (latest) — 2023-08-21

## README

# captcha-generator

Use this program to generate your own captcha image from string


## Usage
Import the package and use the function:
```javascript
const captcha = require('captcha-generator')
const callback = (buffer) => {
    console.log(buffer)
}
captcha("<your string>", callback)
```
Additonally this function can take another argument with the following params:
```javascript
const params = {
    offset: int,
    height: int,
    out_name: string,
    img_overlap_min: float,
    img_overlap_max: float,
    back_color: string,
    out_to_img, boolean
}
```
- **offset:** pixel value for the right and left offset of generated image
- **height:** pixel value of image height
- **out_name** : name for output file ex. captcha
- **img_overlap** : min and max values that define overlaping of image characters. Values from 0 to 1
- **back_color:** : background color of image
- **out_to_img:** : checks if output image will be saved

## License
This project is licensed under the MIT License

## Dependencies
Jimp ^0.22.10

---
_Source: https://npm.io/package/captcha-generator-md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._