https://github.com/chrisyip/node-captchar
Generate captcha image. Written in Node.js.
https://github.com/chrisyip/node-captchar
Last synced: 8 months ago
JSON representation
Generate captcha image. Written in Node.js.
- Host: GitHub
- URL: https://github.com/chrisyip/node-captchar
- Owner: chrisyip
- License: mit
- Created: 2014-07-04T18:35:48.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-03-02T10:16:39.000Z (over 11 years ago)
- Last Synced: 2025-01-31T10:26:02.004Z (over 1 year ago)
- Language: JavaScript
- Size: 142 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Captchar
[![Node version][node-image]][npm-url] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
Generate captcha image. Written in Node.js.
## Installation
Node-captchar requires [canvas](https://www.npmjs.org/package/canvas), pleace follow canvas's installation [wiki](https://github.com/LearnBoost/node-canvas/wiki/_pages) to install dependencies.
## Features
- Background noises
- Support dummy character (presented in red color)
- Customizable string pool
## Usage
```js
var captchar = require('captchar')
captchar()
.then(function (data) {
console.log(data)
})
/*
{
src: '/PATH/TO/PROJECT/.captchar/73f1b787f3f125d8091b3a640343d4de.png,
code: 'TyK2'
}
*/
captchar({ format: 'datauri' })
.then(function (data) {
console.log(data)
})
/*
{
src: 'data:image/png',
code: '5HPp'
}
*/
captchar({ format: 'stream' })
.then(function (data) {
console.log(data)
})
/*
{
src:
{
sync: undefined,
canvas: [Canvas 80x30],
readable: true,
_events: {}
},
code: 'jF4i'
}
*/
```
## Options
```js
captchar({
width: 80,
height: 30,
fontSize: 22,
fontFamily: 'Times New Roman',
textLength: 4, // dummy character is not included
backgroundColor: '#fff',
outputDir: process.cwd()) + '/.captchar/',
imageName: md5(Date.now().toString())) + '.png', // do not pass .png; recommend to generate image name manually
format: 'fs', // 'stream', or 'datauri'. otherwise, out to `disk`
pool: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
dummy: true // set to `false` to turn dummy off
})
```
Example with default options:
The real code is `5HPp`, `o` is dummy.
## Contributors
- [Chris Yip](https://github.com/chrisyip/node-captchar/commits/master?author=chrisyip)
[node-image]: http://img.shields.io/node/v/captchar.svg?style=flat-square
[npm-url]: https://npmjs.org/package/node-captchar
[npm-image]: http://img.shields.io/npm/v/captchar.svg?style=flat-square
[daviddm-url]: https://david-dm.org/chrisyip/node-captchar
[daviddm-image]: http://img.shields.io/david/chrisyip/node-captchar.svg?style=flat-square