Merge branch 'EvolutionX-10-docs'

README.md

@@ -1,10 +1,10 @@
 # Sern
 
-Sern is making easier to create & automate your discord bot with new version compatibility and full customization.
+Sern automates and streamlines development your discord bot with new version compatibility and full customization.
 
-- A reincarnation of [this old project](https://github.com/jacoobes/sern_handler)
+-   A reincarnation of [this old project](https://github.com/jacoobes/sern_handler)
 
-# Installation
+## Installation
 
 ```sh
 npm install sern-handler
@@ -16,78 +16,42 @@ yarn add sern-handler
 
 # Basic Usage
 
-Typescript
+### [Typescript](https://www.typescriptlang.org/)
+
 ```ts
-import { Client } from 'discord.js'
-import { Intents } from 'discord.js'
-import { prefix, token } from "../src/secrets.json"
-import { Sern } from "sern-handler"
+import { Client } from 'discord.js';
+import { Intents } from 'discord.js';
+import { prefix, token } from '../src/secrets.json';
+import { Sern } from 'sern-handler';
 
 const client = new Client({
-    intents: [
-        Intents.FLAGS.GUILDS,
-        Intents.FLAGS.GUILD_MESSAGES,
-        Intents.FLAGS.GUILD_MEMBERS
-    ]
+    intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_MEMBERS],
+});
 
-})
-
- new Sern.Handler( {
+new Sern.Handler({
     client,
     prefix,
-    commands : 'dist/commands',
-    privateServers : [
+    commands: 'dist/commands', // after compiling with tsc 
+    privateServers: [
         {
-            test : true,
-            id: 'server-id'
-        }
+            test: true,
+            id: 'server id',
+        },
     ],
-    init: async (handler : Sern.Handler) => {
-        // Optional function to initialize anything else on bot startup
+    init: async (handler: Sern.Handler) => {
+        /* An optional function to initialize anything else on bot startup */
     },
 });
-```
-
-JavaScript
-```js
-import { Client, Intents } from 'discord.js';
-import { Handler } from 'sern-handler';
-import { prefix, token } from '../src/secrets.json';
-
-const client = new Client({
-    intents: [
-        Intents.FLAGS.GUILDS,
-        Intents.FLAGS.GUILD_MESSAGES,
-        Intents.FLAGS.GUILD_MEMBERS
-    ]
-});
-
-// Access handler anywhere
-client.handler = new Handler({
-    client,   
-    prefix,   
-    commands : 'dist/commands', 
-    privateServers : [           
-        {
-            test : true,
-            id: 'server-id'
-        }
-    ],
-    init: async (handler) => {
-        // Optional function to initialize anything else on bot startup
-    },
-});
-
 
 client.login(token);
 ```
 
-# Links
+## Links ![link](https://img.shields.io/badge/Coming-Soon-orange)
 
-- 📑 [Official Documentation](https://sernhandler.js.org)
-- 🎧 [Discord Server](https://discord.gg/QWQWQWQ)
+-   📑 Official Documentation
+-   🎧 Discord Server  
 
-# Contribute
-- Pull up on issues and tell me if there are bugs.
-- Check issues.
-- Any contributions are open to suggestion!
+## Contribute 😄
+
+-   Pull up on [issues](https://github.com/jacoobes/Sern/issues) and tell me if there are bugs
+-   All kinds of contributions are welcomed!

src/handler/utilities/messageHelpers.ts

@@ -1,13 +1,35 @@
 import type { Message } from 'discord.js';
-
+/**
+ * Checks if the author of message is a bot or not
+ * @param message The message to check
+ * @returns `true` if the author of the message is a bot, `false` otherwise
+ * @example
+ * isBot(message) ? 'yes it is a bot' : 'no it is not a bot';
+ */
 export function isBot(message: Message) {
     return message.author.bot;
 }
-
+/**
+ * Checks if the message **starts** with the prefix
+ * @param message The message to check
+ * @param prefix The prefix to check for
+ * @returns `true` if the message starts with the prefix, `false` otherwise
+ * @example
+ * hasPrefix(message, '!') ? 'yes it does' : 'no it does not';
+ */
 export function hasPrefix(message: Message, prefix: string) {
     return message.content.slice(0, prefix.length).toLowerCase().trim() === prefix;
 }
-
+/**
+ * Removes the first character(s) _[depending on prefix length]_ of the message
+ * @param message The message to remove the prefix from
+ * @param prefix The prefix to remove
+ * @returns The message without the prefix
+ * @example
+ * message.content = '!ping';
+ * console.log(fmt(message, '!'));
+ * // [ 'ping' ]
+ */
 export function fmt(msg: Message, prefix: string): string[] {
     return msg.content.slice(prefix.length).trim().split(/\s+/g);
 }