captcha

Documentation

Index

• Variables
• func Captcha(opts ...*Options) func(echo.Context) error
• type IDGenerator
• type Options
  • func New(prefix string) *Options
  • func (o *Options) SetAudioLangs(audioLangs ...string) *Options
  • func (o *Options) SetCookieName(name string) *Options
  • func (o *Options) SetEnableAudio(enable bool) *Options
  • func (o *Options) SetEnableDownload(enable bool) *Options
  • func (o *Options) SetEnableImage(enable bool) *Options
  • func (o *Options) SetHeaderName(name string) *Options
  • func (o *Options) SetIDGenerator(h IDGenerator) *Options
  • func (o *Options) SetPrefix(prefix string) *Options
  • func (o Options) Wrapper(e echo.RouteRegister) echo.IRouter

Variables

var DefaultOptions = &Options{
	EnableImage:    true,
	EnableAudio:    true,
	EnableDownload: true,
	AudioLangs:     []string{`zh`, `ru`, `en`},
	Prefix:         `/captcha`,
	CookieName:     `captchaId`,
	HeaderName:     `X-Captcha-Id`,
	IDGenerator: func(_ echo.Context, _ *Options) (string, error) {
		return captcha.New(), nil
	},
}

Functions

func Captcha

func Captcha(opts ...*Options) func(echo.Context) error

Types

type IDGenerator

type IDGenerator func(echo.Context, *Options) (string, error)

type Options

type Options struct {
	EnableImage    bool
	EnableAudio    bool
	EnableDownload bool
	AudioLangs     []string
	Prefix         string
	CookieName     string
	HeaderName     string
	IDGenerator    IDGenerator
}

func New

func New(prefix string) *Options

func (*Options) SetAudioLangs

func (o *Options) SetAudioLangs(audioLangs ...string) *Options

func (*Options) SetCookieName

func (o *Options) SetCookieName(name string) *Options

func (*Options) SetEnableAudio

func (o *Options) SetEnableAudio(enable bool) *Options

func (*Options) SetEnableDownload

func (o *Options) SetEnableDownload(enable bool) *Options

func (*Options) SetEnableImage

func (o *Options) SetEnableImage(enable bool) *Options

func (*Options) SetHeaderName

func (o *Options) SetHeaderName(name string) *Options

func (*Options) SetIDGenerator

func (o *Options) SetIDGenerator(h IDGenerator) *Options

func (*Options) SetPrefix

func (o *Options) SetPrefix(prefix string) *Options

func (Options) Wrapper

func (o Options) Wrapper(e echo.RouteRegister) echo.IRouter