Languages:

• English (en)
• Persian (Farsi) (fa)

JavaScript Captcha Production Module

How to use:

• install:

npm:

npm i captcha-dot-js

yarn:

yarn add captcha-dot-js

pnpm:

pnpm i captcha-dot-js

• import:

const captcha = require('captcha-dot-js');

• using:

Using the module is just same as how you call a function, and then as an object you send inputs to it that include the following values, It is mandatory for them to enter the value, All values are boolean type; For example:

const captcha = require('captcha-dot-js');

(async () => {
  const myCaptcha = await captcha({
    numbers: true,
    lowercase: true,
    uppercase: true,
    symbols: false,
    difficulty : 1,
    path : './public'
  });
})();

Value	Description
numbers	In captcha, have numbers or not
lowercase	In captcha, have lowercase alphabet or not
uppercase	In captcha, have uppercase alphabet or not
symbols	In captcha, have symbols (special characters) or not
difficulty	Determines the hardness value of captcha
path	Specifies the storage folder of captcha images

• Recursive values:

‍‍The recursive values of an object is the same as the example below:

{ file_name: 'kvacjoxqjwlveibk.png', captcha: 'pkcsos' }

Values:

Value	Description
file_name	Name of the image file (which captcha is drawn in)
captcha	Captcha value (that is entered in photo)

Final sentence:

If you have problems or suggestions feel free to open issues; Also this module will be updated from time to time for security reasons, So don't forget to update!

ماژول تولید کپچا برای جاوا اسکریپت (نود جی‌اس)

روش استفاده:

• نصب:

ان‌پی‌ام (npm):

npm i captcha-dot-js

یارن (yarn):

yarn add captcha-dot-js

پی‌ان‌پی‌ام (pnpm):

pnpm i captcha-dot-js

• وارد کردن به پروژه (import):

const captcha = require('captcha-dot-js');

• استفاده:

استفاده از این ماژول مثل صدا زدن یک عملگر است؛ مقادیر را به صورت شیء به آن ارسال می‌کنیم؛ وارد نمودن تمامی مقادیر اجباری‌ست، تمامی مقادیر بولی (درست/نادرست) هستند؛ به عنوان مثال:

const captcha = require('captcha-dot-js');

(async () => {
  const myCaptcha = await captcha({
    numbers: true,
    lowercase: true,
    uppercase: true,
    symbols: false,
    difficulty : 1,
    path : './public'
  });
})();

مقادیر	توضیحات
numbers	در کپچا، اعداد باشند یا خیر
lowercase	در کپچا، حروف کوچک باشند یا خیر
uppercase	در کپچا، حروف بزرگ باشند یا خیر
symbols	در کپچا، نمادها (کاراکترهای ویژه) باشند یا خیر
difficulty	سختی مقدار کپچا را تعیین می‌کند
path	مکان ذخیره تصویر کپچا را تعیین می‌کند

• مقادیر بازگشتی: مقادیر بازگشتی مثل مثال زیر است:

{ file_name: 'kvacjoxqjwlveibk.png', captcha: 'pkcsos' }

مقادیر:

مقادیر	توضیحات
file_name	نام عکس (که در آن کپچا کشیده شده است)
captcha	مقدار کپچا (که در عکس کشیده شده)

سخن پایانی:

برای هر گونه پیشنهاد و یا مشکل، ایشو جدیدی ایجاد فرمایید، ضمناً این ماژول (به دلایل امنیتی) زیاد به‌روزرسانی می‌شود؛ پس لطفاً ماژول را همواره آپدیت نگه دارید!