Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Captcha

The captcha generator

Hierarchy

  • Captcha

Index

Constructors

Properties

blurImg: boolean
filterImg: boolean
gifSize: 17646 = 17646
letters: "abcdefghijklmnopqrstuvwxyz" = 'abcdefghijklmnopqrstuvwxyz'
numberOfDots: number

Methods

  • blur(background: Buffer): void
  • Parameters

    • background: Buffer

      The background buffer

    Returns void

  • dots(background: Buffer, dr: Buffer): void
  • Parameters

    • background: Buffer

      The background buffer

    • dr: Buffer

      The dr buffer

    Returns void

  • filter(background: Buffer): void
  • Parameters

    • background: Buffer

      The background buffer

    Returns void

  • generate(size?: number, color?: Color): { buffer: Buffer; token: string }
  • Parameters

    • size: number = 5

      The number of letters

    • Optional color: Color

      The color of the text

    Returns { buffer: Buffer; token: string }

    The gif buffer and the token

    • buffer: Buffer
    • token: string
  • letter(n: number, pos: number, background: Buffer, swr: Buffer, s1: number, s2: number): number
  • Parameters

    • n: number

      The index of the letter

    • pos: number

      The position of the letter

    • background: Buffer

      The background buffer

    • swr: Buffer

      The sw buffer

    • s1: number

      The s1 value

    • s2: number

      The s2 value

    Returns number

    The new position of the letter

  • line(background: Buffer, swr: Buffer, s1: number): void
  • Parameters

    • background: Buffer

      The background buffer

    • swr: Buffer

      The sw buffer

    • s1: number

      The s1 value

    Returns void

  • makeCaptcha(size: number): { background: Buffer; token: string }
  • Parameters

    • size: number

      The number of letters

    Returns { background: Buffer; token: string }

    The background buffer and the token

    • background: Buffer
    • token: string
  • makeGif(background: Buffer, gif: Buffer, color?: Color): void
  • Parameters

    • background: Buffer

      The background buffer

    • gif: Buffer

      The gif buffer

    • Optional color: Color

      The color of the text

    Returns void

  • random(min: number, max: number): number
  • Parameters

    • min: number

      min size

    • max: number

      max size

    Returns number

    A number between min and max

Generated using TypeDoc