Skip to content

Commit

Permalink
Genrated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shashank3736 authored and actions-user committed Apr 24, 2021
1 parent db1c558 commit 5839e2d
Show file tree
Hide file tree
Showing 6 changed files with 131 additions and 12 deletions.
52 changes: 45 additions & 7 deletions docs/CaptchaGenerator.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,12 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");const fs = require("fs")const captcha = new CaptchaGenerator();const buffer = await captcha.generate() //generate imagefs.writeFileSync("image.png", buffer)</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");
const fs = require("fs")
const captcha = new CaptchaGenerator();
const buffer = await captcha.generate() //generate image

fs.writeFileSync("image.png", buffer)</code></pre>



Expand Down Expand Up @@ -719,7 +724,14 @@ <h6>Properties</h6>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator, resolveImage } = require("captcha-canvas");const fs = require("fs");const img = await resolveImage("./path/to/file");const captcha = new CaptchaGenerator().generateSync({background: img});fs.writeFileSync("image.png", captcha);</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator, resolveImage } = require("captcha-canvas");
const fs = require("fs");
const img = await resolveImage("./path/to/file");

const captcha = new CaptchaGenerator()
.generateSync({background: img});

fs.writeFileSync("image.png", captcha);</code></pre>



Expand Down Expand Up @@ -868,7 +880,13 @@ <h5>Parameters:</h5>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");const fs = require("fs")const captcha = new CaptchaGenerator();captcha.setBackground("./path/toFile");const buffer = await captcha.generate() //generate imagefs.writeFileSync("image.png", buffer)</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");
const fs = require("fs")
const captcha = new CaptchaGenerator();
captcha.setBackground("./path/toFile");
const buffer = await captcha.generate() //generate image

fs.writeFileSync("image.png", buffer)</code></pre>



Expand Down Expand Up @@ -1017,7 +1035,14 @@ <h5>Parameters:</h5>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");const fs = require("fs")const captcha = new CaptchaGenerator();const options = {font: "Comic Sans", size: 60}captcha.setCaptcha(options)const buffer = await captcha.generate() //generate imagefs.writeFileSync("image.png", buffer)</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");
const fs = require("fs")
const captcha = new CaptchaGenerator();
const options = {font: "Comic Sans", size: 60}
captcha.setCaptcha(options)
const buffer = await captcha.generate() //generate image

fs.writeFileSync("image.png", buffer)</code></pre>



Expand Down Expand Up @@ -1333,7 +1358,13 @@ <h5>Parameters:</h5>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");const fs = require("fs")const captcha = new CaptchaGenerator();captcha.setDimension(200, 600);const buffer = await captcha.generate() //generate imagefs.writeFileSync("image.png", buffer)</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");
const fs = require("fs")
const captcha = new CaptchaGenerator();
captcha.setDimension(200, 600);
const buffer = await captcha.generate() //generate image

fs.writeFileSync("image.png", buffer)</code></pre>



Expand Down Expand Up @@ -1482,7 +1513,14 @@ <h5>Parameters:</h5>

<h5>Example</h5>

<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");const fs = require("fs")const captcha = new CaptchaGenerator();const options = {size: 5, color: "deeppink"}captcha.setTrace(options)const buffer = await captcha.generate() //generate imagefs.writeFileSync("image.png", buffer)</code></pre>
<pre class="prettyprint example linenums"><code>const { CaptchaGenerator } = require("captcha-canvas");
const fs = require("fs")
const captcha = new CaptchaGenerator();
const options = {size: 5, color: "deeppink"}
captcha.setTrace(options)
const buffer = await captcha.generate() //generate image

fs.writeFileSync("image.png", buffer)</code></pre>



Expand All @@ -1506,7 +1544,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 10:22:22 GMT+0530 (India Standard Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/constants.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h1 class="page-title">Source: constants.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 10:22:22 GMT+0530 (India Standard Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -1557,7 +1557,7 @@ <h5 class="subsection-title">Properties:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 10:22:22 GMT+0530 (India Standard Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h2>Support</h2>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 10:22:22 GMT+0530 (India Standard Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/main.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h1 class="page-title">Source: main.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const { randomBytes } = require('crypto');
const merge = require("deepmerge");
const { merge } = require("./util");
const {
defaultCaptchaOptions,
defaultTraceOptions,
Expand Down Expand Up @@ -401,7 +401,7 @@ <h1 class="page-title">Source: main.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 10:22:22 GMT+0530 (India Standard Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
Expand Down
81 changes: 81 additions & 0 deletions docs/util.js.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Source: util.js</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<script src="scripts/nav.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/3.4.6/fuse.min.js"></script>

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<link type="text/css" rel="stylesheet" href="styles/skyceil.css">
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css">
</head>

<body>

<nav class="navbar">
<div class="utilities">
<div id="search">
<input type="text" id="search-box" placeholder="Search for stuffs..."><br>
<div id="search-results" style="display: none;"></div>
</div>
<button class="theme" data-theme="light"><i class="fas fa-moon"></i></button>
</div>
<hr>
<h4><a href="index.html">Home</a></h4><h5 class="no-bottom must-underline">Classes</h5><ul><li><span class="small-icon C">C</span><b><a href="CaptchaGenerator.html">CaptchaGenerator</a></b><ul class="has-class-methods"><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#generate">generate</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#generateSync">generateSync</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#setBackground">setBackground</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#setCaptcha">setCaptcha</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#setDecoy">setDecoy</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#setDimension">setDimension</a></li><li><span class="small-icon F">F</span><a href="CaptchaGenerator.html#setTrace">setTrace</a></li><li><span class="small-icon M">M</span><a href="CaptchaGenerator.html#text">text</a></li></ul></li></ul><h4>Global</h4><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>
</nav>

<div id="main">
<div class="burger">
<div class="burger-line-1"></div>
<div class="burger-line-2"></div>
<div class="burger-line-3"></div>
</div>

<h1 class="page-title">Source: util.js</h1>






<section>
<article>
<pre class="prettyprint source linenums"><code>module.exports = {
/**
* Merge two objects
* @param {object} oldObject
* @param {object} newObject
*/
merge: function(oldObject, newObject) {
for (const prop in newObject) {
oldObject[prop] = newObject[prop];
}
return oldObject;
}
}</code></pre>
</article>
</section>





</div>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 06:38:13 GMT+0000 (Coordinated Universal Time) using <a href="https://github.com/devsnowflake/jsdoc-skyceil">Skyceil Theme</a>
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>

</body>
</html>

0 comments on commit 5839e2d

Please sign in to comment.