Class Captcha

constructor

• new Captcha(width?: number, height?: number, characters?: number): Captcha

  Start captcha image creation.

  Parameters

  • Optionalwidth: number = defaultDimension.width

    Width of captcha image.
  • Optionalheight: number = defaultDimension.height

    Height of captcha image.
  • Optionalcharacters: number = ...

    Size of captcha text.

  Returns Captcha

async

png

• get png(): Buffer | Promise<Buffer>

  Get png image of captcha.

  Returns Buffer | Promise<Buffer>

  Get png image of captcha created.

text

• get text(): string

  Get Captcha text.

  Returns string

  Get captcha text.

addDecoy

• addDecoy(decoyOption?: SetDecoyOption): Captcha

  Add decoy on your captcha image.

  Parameters

  • OptionaldecoyOption: SetDecoyOption = {}

    Decoy option you want to customise

  Returns Captcha

drawCaptcha

• drawCaptcha(captchaOption?: DrawCaptchaOption | DrawCaptchaOption[]): Captcha

  Draw captcha text on captcha image.

  Parameters

  • OptionalcaptchaOption: DrawCaptchaOption | DrawCaptchaOption[] = {}

  Returns Captcha

drawImage

• drawImage(image: Image): Captcha

  Draw image on your captcha.

  Parameters

  • image: Image

    Choose image you want to add.

  Returns Captcha

drawTrace

• drawTrace(traceOption?: SetTraceOption): Captcha

  Draw trace line over your captcha.

  Note: If you want to use custom text or change size of captcha text then drawCaptcha before drawTrace.

  Parameters

  • OptionaltraceOption: SetTraceOption = {}

  Returns Captcha