Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shashank3736
Shashank3736 committed Oct 7, 2021
1 parent 7756508 commit bf03513
Show file tree
Hide file tree
Showing 15 changed files with 3,105 additions and 881 deletions.
1,226 changes: 1,226 additions & 0 deletions docs/Captcha.html
View file

Large diffs are not rendered by default.

1,661 changes: 1,661 additions & 0 deletions docs/CaptchaGenerator.html
View file

Large diffs are not rendered by default.

155 changes: 44 additions & 111 deletions docs/CaptchaGenerator.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@

<nav>

<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Global</h3><ul><li><a href="global.html#Captcha">Captcha</a></li><li><a href="global.html#CaptchaGenerator">CaptchaGenerator</a></li><li><a href="global.html#createCaptcha">createCaptcha</a></li><li><a href="global.html#createCaptchaSync">createCaptchaSync</a></li><li><a href="global.html#get">get</a></li></ul></div>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Captcha.html">Captcha</a></li><li><a href="CaptchaGenerator.html">CaptchaGenerator</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createCaptcha">createCaptcha</a></li><li><a href="global.html#createCaptchaSync">createCaptchaSync</a></li></ul></div>

</nav>
</div>
Expand All @@ -86,63 +86,16 @@ <h1>CaptchaGenerator.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
var __assign = (this &amp;&amp; this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i &lt; n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this &amp;&amp; this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this &amp;&amp; this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] &amp; 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" &amp;&amp; (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y &amp;&amp; (t = op[0] &amp; 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) &amp;&amp; t.call(y), 0) : y.next) &amp;&amp; !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] &amp; 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 &amp;&amp; t[t.length - 1]) &amp;&amp; (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 &amp;&amp; (!t || (op[1] > t[0] &amp;&amp; op[1] &lt; t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 &amp;&amp; _.label &lt; t[1]) { _.label = t[1]; t = op; break; }
if (t &amp;&amp; _.label &lt; t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] &amp; 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CaptchaGenerator = void 0;
var skia_canvas_1 = require("skia-canvas");
var _1 = require(".");
var constants_1 = require("./constants");
var util_1 = require("./util");
const skia_canvas_1 = require("skia-canvas");
const _1 = require(".");
const constants_1 = require("./constants");
const util_1 = require("./util");
/**
* Captcha generator class.
*/
var CaptchaGenerator = /** @class */ (function () {
class CaptchaGenerator {
/**
* Initatiates the creation of captcha image generation.
* @example const captcha = new CaptchaGenerator({height: 200, width: 600});
Expand All @@ -151,27 +104,22 @@ <h1>CaptchaGenerator.js</h1>
* @param {integer} [options.width=300] Width of captcha image.
* @since 2.0.0
*/
function CaptchaGenerator(options) {
if (options === void 0) { options = { height: 100, width: 300 }; }
constructor(options = { height: 100, width: 300 }) {
this.height = options.height;
this.width = options.width;
this.captcha = constants_1.defaultCaptchaOption;
this.trace = constants_1.defaultTraceOptions;
this.decoy = constants_1.defaultDecoyOptions;
this.captcha.text = (0, util_1.randomText)(this.captcha.characters);
}
Object.defineProperty(CaptchaGenerator.prototype, "text", {
/**
* Get the text of captcha.
* @type {string}
* @since 2.0.3
*/
get: function () {
return this.captcha.text;
},
enumerable: false,
configurable: true
});
/**
* Get the text of captcha.
* @type {string}
* @since 2.0.3
*/
get text() {
return this.captcha.text;
}
/**
* set dimension for your captcha image
* @param {integer} height Height of captcha image.
Expand All @@ -186,11 +134,11 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", buffer)
* @since 2.0.0
*/
CaptchaGenerator.prototype.setDimension = function (height, width) {
setDimension(height, width) {
this.height = height;
this.width = width;
return this;
};
}
/**
* Set background for captcha image.
* @param {buffer} image Buffer/url/path of image.
Expand All @@ -204,10 +152,10 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", buffer)
* @since 2.0.0
*/
CaptchaGenerator.prototype.setBackground = function (image) {
setBackground(image) {
this.background = image;
return this;
};
}
/**
* Change captcha text options
* @param {SetCaptchaOptions} options Captcha appearance options.
Expand All @@ -222,14 +170,14 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", buffer)
* @since 2.0.0
*/
CaptchaGenerator.prototype.setCaptcha = function (option) {
this.captcha = __assign(__assign({}, this.captcha), option);
setCaptcha(option) {
this.captcha = { ...this.captcha, ...option };
if (option.text)
this.captcha.characters = option.text.length;
if (!option.text &amp;&amp; option.characters)
this.captcha.text = (0, util_1.randomText)(option.characters);
return this;
};
}
/**
* Change trace creation options.
* @param {SetTraceOptions} options Trace Line appearance options.
Expand All @@ -244,19 +192,19 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", buffer)
* @since 2.0.0
*/
CaptchaGenerator.prototype.setTrace = function (option) {
this.trace = __assign(__assign({}, this.trace), option);
setTrace(option) {
this.trace = { ...this.trace, ...option };
return this;
};
}
/**
* Change decoy options
* @param {SetDecoyOptions} options Decoy characters customisation options
* @since 2.0.0
*/
CaptchaGenerator.prototype.setDecoy = function (option) {
this.decoy = __assign(__assign({}, this.decoy), option);
setDecoy(option) {
this.decoy = { ...this.decoy, ...option };
return this;
};
}
/**
* Method which returns image buffer
* @async
Expand All @@ -270,31 +218,18 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", buffer)
* @since 2.0.0
*/
CaptchaGenerator.prototype.generate = function () {
return __awaiter(this, void 0, void 0, function () {
var captchaCanvas, _a, _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
captchaCanvas = new _1.Captcha(this.width, this.height);
if (!this.background) return [3 /*break*/, 2];
_b = (_a = captchaCanvas).drawImage;
return [4 /*yield*/, (0, skia_canvas_1.loadImage)(this.background)];
case 1:
_b.apply(_a, [_c.sent()]);
_c.label = 2;
case 2:
if (this.decoy.opacity)
captchaCanvas.addDecoy(this.decoy);
if (this.captcha.opacity)
captchaCanvas.drawCaptcha(this.captcha);
if (this.trace.opacity)
captchaCanvas.drawTrace(this.trace);
return [2 /*return*/, captchaCanvas.png];
}
});
});
};
async generate() {
const captchaCanvas = new _1.Captcha(this.width, this.height);
if (this.background)
captchaCanvas.drawImage(await (0, skia_canvas_1.loadImage)(this.background));
if (this.decoy.opacity)
captchaCanvas.addDecoy(this.decoy);
if (this.captcha.opacity)
captchaCanvas.drawCaptcha(this.captcha);
if (this.trace.opacity)
captchaCanvas.drawTrace(this.trace);
return captchaCanvas.png;
}
/**
* Non asynchronous method to generate captcha image.
* > Note: It do not use `setBackground` method value for background image. If you want to set background
Expand All @@ -312,9 +247,8 @@ <h1>CaptchaGenerator.js</h1>
* fs.writeFileSync("image.png", captcha);
* @since 2.2.0
*/
CaptchaGenerator.prototype.generateSync = function (option) {
if (option === void 0) { option = {}; }
var captchaCanvas = new _1.Captcha(this.width, this.height);
generateSync(option = {}) {
const captchaCanvas = new _1.Captcha(this.width, this.height);
captchaCanvas.async = false;
if (option.background)
captchaCanvas.drawImage(option.background);
Expand All @@ -325,9 +259,8 @@ <h1>CaptchaGenerator.js</h1>
if (this.trace.opacity)
captchaCanvas.drawTrace(this.trace);
return captchaCanvas.png;
};
return CaptchaGenerator;
}());
}
}
exports.CaptchaGenerator = CaptchaGenerator;
</code></pre>
</article>
Expand Down
Loading

0 comments on commit bf03513

Please sign in to comment.