Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shashank3736 committed Apr 4, 2024
1 parent 97692f8 commit 9b8b822
Show file tree
Hide file tree
Showing 67 changed files with 1,550 additions and 1,548 deletions.
94 changes: 22 additions & 72 deletions docs/CaptchaGenerator.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

<nav>

<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>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="CaptchaGenerator.html">CaptchaGenerator</a></li></ul><h3>Global</h3><ul><li><a href="global.html#defaultCaptchaOptions">defaultCaptchaOptions</a></li><li><a href="global.html#defaultDecoyOptions">defaultDecoyOptions</a></li><li><a href="global.html#defaultTraceOptions">defaultTraceOptions</a></li><li><a href="global.html#getRandom">getRandom</a></li></ul></div>

</nav>
</div>
Expand All @@ -85,9 +85,9 @@ <h1>CaptchaGenerator</h1>

<header>

<h2><span class="attribs"><span class="type-signature"></span></span>CaptchaGenerator<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
<h2><span class="attribs"><span class="type-signature"></span></span>CaptchaGenerator<span class="signature">(options)</span><span class="type-signature"></span></h2>

<div class="class-description"><p>Captcha generator class.</p></div>
<div class="class-description"><p>Captcha Generator</p></div>


</header>
Expand All @@ -111,7 +111,7 @@ <h4 class="name" id="CaptchaGenerator">

<span class="code-name">

new CaptchaGenerator<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span>
new CaptchaGenerator<span class="signature">(options)</span><span class="type-signature"></span>

</span>
</h4>
Expand Down Expand Up @@ -145,12 +145,8 @@ <h5>Parameters:</h5>
<th>Type</th>


<th>Attributes</th>



<th>Default</th>


<th class="last">Description</th>
</tr>
Expand All @@ -175,22 +171,8 @@ <h5>Parameters:</h5>
</td>


<td class="attributes">

&lt;optional><br>





</td>



<td class="default">

</td>


<td class="description last"><p>Options for constructor.</p></td>
</tr>
Expand All @@ -213,24 +195,8 @@ <h5>Parameters:</h5>
</td>


<td class="attributes">

&lt;optional><br>





</td>



<td class="default">

100

</td>


<td class="description last"><p>Height of captcha image.</p></td>
</tr>
Expand All @@ -252,24 +218,8 @@ <h5>Parameters:</h5>
</td>


<td class="attributes">

&lt;optional><br>





</td>



<td class="default">

300

</td>


<td class="description last"><p>Width of captcha image.</p></td>
</tr>
Expand Down Expand Up @@ -322,9 +272,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line11">line 11</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line32">line 32</a>
</span>
</p>

Expand Down Expand Up @@ -448,9 +398,9 @@ <h4 class="name" id="text">


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line33">line 33</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line85">line 85</a>
</span>
</p>

Expand Down Expand Up @@ -545,9 +495,9 @@ <h4 class="name" id="generate">


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line134">line 134</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line190">line 190</a>
</span>
</p>

Expand Down Expand Up @@ -778,9 +728,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line163">line 163</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line273">line 273</a>
</span>
</p>

Expand Down Expand Up @@ -936,9 +886,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line68">line 68</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line121">line 121</a>
</span>
</p>

Expand Down Expand Up @@ -1094,9 +1044,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line86">line 86</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line139">line 139</a>
</span>
</p>

Expand Down Expand Up @@ -1252,9 +1202,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line117">line 117</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line173">line 173</a>
</span>
</p>

Expand Down Expand Up @@ -1428,9 +1378,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line50">line 50</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line103">line 103</a>
</span>
</p>

Expand Down Expand Up @@ -1586,9 +1536,9 @@ <h5>Parameters:</h5>


<p class="tag-source">
<a href="CaptchaGenerator.js.html" class="button">View Source</a>
<a href="main.js.html" class="button">View Source</a>
<span>
<a href="CaptchaGenerator.js.html">CaptchaGenerator.js</a>, <a href="CaptchaGenerator.js.html#line108">line 108</a>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line164">line 164</a>
</span>
</p>

Expand Down
111 changes: 45 additions & 66 deletions docs/constants.js.html
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>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>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="CaptchaGenerator.html">CaptchaGenerator</a></li></ul><h3>Global</h3><ul><li><a href="global.html#defaultCaptchaOptions">defaultCaptchaOptions</a></li><li><a href="global.html#defaultDecoyOptions">defaultDecoyOptions</a></li><li><a href="global.html#defaultTraceOptions">defaultTraceOptions</a></li><li><a href="global.html#getRandom">getRandom</a></li></ul></div>

</nav>
</div>
Expand All @@ -85,38 +85,18 @@ <h1>constants.js</h1>

<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CreateCaptchaOptions = exports.defaultDimension = exports.defaultDecoyOptions = exports.defaultTraceOptions = exports.defaultCaptchaOption = exports.defaultDrawCaptchaOption = void 0;
;
;
;
;
;
/**
* Captcha text options to customise text appearance and value.
* @typedef DrawCaptchaOption
* @property {string} [text="Random UpperCase string"] Text of captcha
* @property {hexCode} [color="#32cf7e"] Color of captcha text.
* @property {font} [font="Sans"] Font of captcha text.
* @property {boolean} [skew=true] Skew captcha text.
* @property {array} [colors=[]] Array of hexCode will override color property.
* @property {number} [rotate=5] Range of angle to rotate text.
* @property {number} [size=40] Size of captcha text.
* @property {float} [opacity=1] Opcaity of captcha text.
<pre class="prettyprint source linenums"><code>/**
* Customise dimension of captcha image.
*
* @typedef SetDimensionOption
* @property {integer} [height=100] Height of captcha image.
* @property {integer} [width=300] Width of captcha image.
*/
exports.defaultDrawCaptchaOption = {
characters: 6,
size: 40,
font: 'Sans',
skew: true,
colors: [],
rotate: 5,
color: '#32cf7e',
opacity: 0.8,
};
exports.SetDimensionOption = {};

/**
* Captcha text options to customise text appearance and value.
*
* @typedef SetCaptchaOptions
* @property {integer} [characters=6] Length of captcha text.
* @property {string} [text="Random UpperCase string"] Text of captcha
Expand All @@ -128,61 +108,60 @@ <h1>constants.js</h1>
* @property {number} [size=40] Size of captcha text.
* @property {float} [opacity=1] Opcaity of captcha text.
*/
exports.defaultCaptchaOption = {
characters: 6,
size: 40,
font: 'Sans',
skew: true,
colors: [],
rotate: 5,
color: '#32cf7e',
opacity: 0.8,
};
exports.SetCaptchaOptions = {};

/**
* @typedef SetTraceOptions
* @property {hexCode} [color="#32cf7e"] Color of trace line.
* @property {number} [size=3] Width of trace line.
* @property {float} [opacity=1] Opacoty of trace line.
*/
exports.defaultTraceOptions = {
size: 3,
color: '#32cf7e',
opacity: 1,
};
exports.SetTraceOptions = {};

/**
* @typedef SetDecoyOptions
* @property {hexCode} [color="#646566"] Color of decoy characters.
* @property {font} [font="Sans"] Font of decoy characters.
* @property {number} [size=20] Size of decoy characters.
* @property {float} [opacity=0.8] Opacity of decoy characters.
* @property {number} [total] Total count of decoy characters.
*/
exports.defaultDecoyOptions = {
color: '#646566',
font: 'Sans',
size: 20,
opacity: 0.8,
exports.SetDecoyOptions = {};

/**
* Default captcha customisation options.
* @type {SetCaptchaOptions}
*/
exports.defaultCaptchaOptions = {
characters: 6,
size: 40,
font: 'Sans',
skew: true,
colors: [],
rotate: 5,
color: '#32cf7e',
opacity: 0.8,
};

/**
* Customise dimension of captcha image.
* @typedef SetDimensionOption
* @property {integer} [height=100] Height of captcha image.
* @property {integer} [width=300] Width of captcha image.
* Default trace line options.
* @type {SetTraceOptions}
*/
exports.defaultDimension = {
height: 100,
width: 300
exports.defaultTraceOptions = {
size: 3,
color: '#32cf7e',
opacity: 1,
};

/**
* Create captcha options in functions.
* @typedef CreateCaptchaOptions
* @property {SetCaptchaOptions} [captcha] Captcha text options to customise text appearance and value.
* @property {SetDecoyOptions} [decoy]
* @property {SetTraceOptions} [trace]
* @property {Image} [background]
* Default Decoy Options
* @type {SetDecoyOptions}
*/
exports.CreateCaptchaOptions = {};
</code></pre>
exports.defaultDecoyOptions = {
color: '#646566',
font: 'Sans',
size: 20,
opacity: 0.8,
};</code></pre>
</article>
</section>

Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 9b8b822

Please sign in to comment.