Class Captcha

Generates a Captcha Image

Index

Constructors

Properties

_canvas _h _value

Accessors

JPEGStream PNGStream dataURL value

Methods

clearCanvas drawLines drawRandomCircles drawText generateCaptcha

Constructors

constructor

new Captcha(_h?): Captcha
Creates an instance of Captcha.
Parameters
- _h: number = 250
  The height of the captcha image
Returns Captcha
- Defined in src/classes/API/CaptchaClass.ts:52

Properties

`Private` _canvas

_canvas: Canvas

`Private` _h

_h: number = 250

The height of the captcha image

`Private` _value

_value: string = ""

Accessors

JPEGStream

get JPEGStream(): JPEGStream
Gets the JPEG stream of the captcha image

Returns JPEGStream
The JPEG stream of the captcha image
- Defined in src/classes/API/CaptchaClass.ts:197

PNGStream

get PNGStream(): PNGStream
Gets the PNG stream of the captcha image

Returns PNGStream
The PNG stream of the captcha image
- Defined in src/classes/API/CaptchaClass.ts:189

dataURL

get dataURL(): string
Gets the data URL of the captcha image

Returns string
The data URL of the captcha image
- Defined in src/classes/API/CaptchaClass.ts:205

value

get value(): string
Gets the value of the captcha

Returns string
The value of the captcha
- Defined in src/classes/API/CaptchaClass.ts:181

Methods

`Private` clearCanvas

clearCanvas(ctx): void
Private
Clears the canvas
Parameters
- ctx: CanvasRenderingContext2D
  The canvas rendering context
Returns void
- Defined in src/classes/API/CaptchaClass.ts:80

`Private` drawLines

drawLines(ctx): void
Private
Draws random lines on the canvas
Parameters
- ctx: CanvasRenderingContext2D
  The canvas rendering context
Returns void
- Defined in src/classes/API/CaptchaClass.ts:96

`Private` drawRandomCircles

drawRandomCircles(ctx): void
Private
Draws random circles on the canvas
Parameters
- ctx: CanvasRenderingContext2D
  The canvas rendering context
Returns void
- Defined in src/classes/API/CaptchaClass.ts:154

`Private` drawText

drawText(ctx): void
Private
Draws the captcha text on the canvas
Parameters
- ctx: CanvasRenderingContext2D
  The canvas rendering context
Returns void
- Defined in src/classes/API/CaptchaClass.ts:124

`Private` generateCaptcha

generateCaptcha(): void
Private
Generates the captcha image

Returns void
- Defined in src/classes/API/CaptchaClass.ts:62

Generated using TypeDoc