Docs

devdeem · Oct 19, 2023 · 54406b5 · 54406b5
1 parent 17f3a17
commit 54406b5
Show file tree

Hide file tree

Showing 29 changed files with 9,401 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules/
 test/
-package-lock.json
+package-lock.json
+docREADME.md
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,5 @@
 node_modules/
 test/
-package-lock.json
+package-lock.json
+docREADME.md
+docs/
diff --git a/README.md b/README.md
@@ -14,11 +14,7 @@ Custom formatted **Console Logs** and **Anti-Crash** system for your Discord bot
 To install this package simply run:
 
 ```bash
-npm install term-logger@latest
-or
-yarn add term-logger@latest
-or
-pnpm add term-logger@latest
+npm i term-logger@latest
 ```
 
 ## Usage

diff --git a/docs/term-logger/1.2.0/data/search.json b/docs/term-logger/1.2.0/data/search.json
@@ -0,0 +1 @@
+{"list":[]}
diff --git a/docs/term-logger/1.2.0/fonts/Inconsolata-Regular.ttf b/docs/term-logger/1.2.0/fonts/Inconsolata-Regular.ttf
diff --git a/docs/term-logger/1.2.0/fonts/OpenSans-Regular.ttf b/docs/term-logger/1.2.0/fonts/OpenSans-Regular.ttf
diff --git a/docs/term-logger/1.2.0/fonts/WorkSans-Bold.ttf b/docs/term-logger/1.2.0/fonts/WorkSans-Bold.ttf
diff --git a/docs/term-logger/1.2.0/index.html b/docs/term-logger/1.2.0/index.html
@@ -0,0 +1,46 @@
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="author" content="DEEM"><meta name="description" content="Custom formatted Console Logs and Anti-Crash system for your Discord bot!"><title>Term Logger</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/devdeem/term-logger" target="_blank">Github</a></div><div class="navbar-item"><a id="" href="https://support.roblybot.xyz" target="_blank">Discord Server</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/term-logger" target="_blank">Package</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section class="readme"><article><p><img src="https://cdn.discordapp.com/attachments/1050740855805313064/1125727738410573894/Logo.png" alt="banner"></p><p>Custom formatted <strong>Console Logs</strong> and <strong>Anti-Crash</strong> system for your Discord bot!</p><p><img src="https://img.shields.io/npm/v/term-logger" alt="version"> <img src="https://img.shields.io/npm/collaborators/term-logger" alt="collaborators"> <img src="https://img.shields.io/npm/dt/term-logger" alt="downloads"> <img src="https://img.shields.io/npm/l/term-logger" alt="licence"></p><h2 id="installation">Installation</h2><p>To install this package simply run:</p><pre class="prettyprint source lang-bash"><code>npm i term-logger@latest
+</code></pre><h2 id="usage">Usage</h2><p>Usage only for Console Logs</p><pre class="prettyprint source lang-javascript"><code>const { Logger } = require(&quot;term-logger&quot;);
+
+//Defaul Logs
+Logger.error(`Example log text!`);
+Logger.debug(`Example log text!`);
+Logger.info(`Example log text!`);
+Logger.warn(`Example log text!`);
+Logger.critical(`Example log text!`);
+
+//Discord Logs
+Logger.ready(`Example log text!`);
+Logger.command(`Example log text!`);
+Logger.event(`Example log text!`);
+Logger.database(`Example log text!`);
+Logger.shard(`Example log text!`);
+Logger.cluster(`Example log text!`);
+Logger.lang(&quot;Example log text!&quot;);
+</code></pre><p>Usage for Colors</p><pre class="prettyprint source lang-javascript"><code>const { Colors } = require(&quot;term-logger&quot;);
+
+Colors.grey(&quot;message&quot;);
+Colors.red(&quot;message&quot;);
+Colors.green(&quot;message&quot;);
+Colors.yellow(&quot;message&quot;);
+Colors.blue(&quot;message&quot;);
+Colors.purple(&quot;message&quot;);
+Colors.cyan(&quot;message&quot;);
+Colors.white(&quot;message&quot;);
+</code></pre><p>Usage only for Anti-Crash</p><pre class="prettyprint source lang-javascript"><code>const { Client } = require(&quot;discord.js&quot;);
+const { TermLogger } = require(&quot;term-logger&quot;);
+
+const client = new Client({
+  intents: [...],
+});
+
+// You can enable/disable system logs (Use only Boolean)
+const noCrash = new TermLogger(client, {
+  enableAntiCrash: true,
+  systemMessages: true,
+});
+
+client.login(&quot;YOUR_BOT_TOKEN&quot;);
+</code></pre><h1 id="documentation">Documentation</h1><h2 id="package-options">Package Options</h2><h3 id="constructor">Constructor</h3><pre class="prettyprint source lang-javascript"><code>new TermLogger(client);
+</code></pre><table><tr><th>Parameter</th><th>Type</th><th>Description</th></tr><tr><td>enableAntiCrash</td><td>Boolean</td><td>Enable or disable AntiCrash system</td></tr><tr><td>systemMessages</td><td>Boolean</td><td>Enable or disable system messages</td></tr></table><h3>Logger Options</h3><table><tr><th>Method</th><th>Description</th></tr><tr><td>Logger.error("message")</td><td>Logs an error message</td></tr><tr><td>Logger.debug("message")</td><td>Logs a debug message</td></tr><tr><td>Logger.info("message")</td><td>Logs an information message</td></tr><tr><td>Logger.warn("message")</td><td>Logs a warning message</td></tr><tr><td>Logger.critical("message")</td><td>Logs a critical message</td></tr><tr><td>Logger.ready("message")</td><td>Logs a message indicating that the app is ready</td></tr><tr><td>Logger.command("message")</td><td>Logs a message that the command was executed</td></tr><tr><td>Logger.event("message")</td><td>Logs a message that the event has been loaded</td></tr><tr><td>Logger.database("message")</td><td>Logs a message related to database operations</td></tr><tr><td>Logger.shard("message")</td><td>Logs a message related to shards</td></tr><tr><td>Logger.cluster("message")</td><td>Logs a message related to clusters</td></tr><tr><td>Logger.lang("message")</td><td>Logs a message related to language</td></tr></table><p><b>Message must always be either a STRING or DATA!</b></p><h3>Colors Options</h3><table><tr><th>Colors</th></tr><tr><td>Grey</td></tr><tr><td>Red</td></tr><tr><td>Green</td></tr><tr><td>Yellow</td></tr><tr><td>Blue</td></tr><tr><td>Purple</td></tr><tr><td>Cyan</td></tr><tr><td>White</td></tr></table><h1 id="do-you-have-any-issues%3F">Do you have any issues?</h1><p>If you have any issues don't hesitate to report it via <a href="https://github.com/devdeem/term-logger/issues">Github Issues</a>.</p><h1 id="support">Support</h1><p>If you need help or assistance please either ask in my <a href="https://support.roblybot.xyz/">Discord Server</a> and if you have an idea what to add to term-logger let us know on support.</p><h1 id="sponsor-us">Sponsor Us</h1><p>Do you use <strong>Term-Logger</strong> and are you satisfied? You can support us with a one-time donation to help us improve our work: <a href="https://ko-fi.com/deemdev">Donate here</a>.</p><p><a href="https://discord.gg/UdKSrxBXyd"><img src="https://api.weblutions.com/discord/invite/UdKSrxBXyd/" alt="Discord Banner"></a></p><blockquote><p>Developed by @deemdev with ❤️</p></blockquote></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/devdeem/term-logger" target="_blank">Github</a></div><div class="navbar-item"><a id="" href="https://support.roblybot.xyz" target="_blank">Discord Server</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/term-logger" target="_blank">Package</a></div></div><div class="mobile-sidebar-items-c"></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>