Skip to content

Repository files navigation

Captchar

Node versionNPM versionDependency Status

Generate captcha image. Written in Node.js.

Installation

Node-captchar requires canvas, pleace follow canvas's installation wiki to install dependencies.

Features

  • Background noises
  • Support dummy character (presented in red color)
  • Customizable string pool

Usage

varcaptchar=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

captchar({width: 80,height: 30,fontSize: 22,fontFamily: 'Times New Roman',textLength: 4,// dummy character is not includedbackgroundColor: '#fff',outputDir: process.cwd())+'/.captchar/',imageName: md5(Date.now().toString()))+'.png',// do not pass .png; recommend to generate image name manuallyformat: '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

About

Generate captcha image. Written in Node.js.

Resources

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages