captcha

Documentation

Index

• type Captcha
  • func NewCaptcha(opfs ...func(option *Option)) *Captcha
  • func (c *Captcha) GenCode(id, value string) (b64s string, err error)
  • func (c *Captcha) GenCodeAuto() (id, value, b64s string, err error)
  • func (c *Captcha) Validate(id, answer string) bool
• type Option

Types

type Captcha

type Captcha struct {
	*base64Captcha.Captcha
}

func NewCaptcha

func NewCaptcha(opfs ...func(option *Option)) *Captcha

func (*Captcha) GenCode

func (c *Captcha) GenCode(id, value string) (b64s string, err error)

func (*Captcha) GenCodeAuto

func (c *Captcha) GenCodeAuto() (id, value, b64s string, err error)

func (*Captcha) Validate

func (c *Captcha) Validate(id, answer string) bool

type Option

type Option struct {
	// EnableRedis user redis as store.
	EnableRedis bool
	// Height png height in pixel.
	Height int
	// Width Captcha png width in pixel.
	Width int
	// DefaultLen Default number of digits in captcha solution.
	Length int
	// MaxSkew max absolute skew factor of a single digit.
	MaxSkew float64
	// DotCount Number of background circles.
	DotCount int
	// ExpireTime Redis expireTime.
	ExpireTime time.Duration
}