Docs update

package.json

@@ -5,7 +5,7 @@
   "repository": "https://github.com/StrafeChat/strafe.js",
   "main": "dist/index",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc -p . && typedoc --json website/docs.json"
   },
   "keywords": [],
   "author": "StrafeChat <docs.strafe.chat>",
@@ -16,7 +16,8 @@
   },
   "devDependencies": {
     "@types/node": "^20.10.6",
-    "@types/ws": "^8.5.10"
+    "@types/ws": "^8.5.10",
+    "typedoc": "^0.25.6"
   },
   "files": [
     "dist"

src/client/Client.ts

@@ -1,6 +1,9 @@
 import { ClientUser } from "../structure/ClientUser";
 import { WebsocketClient } from "./WebsocketClient";
 
+/**
+ * The main hub for interacting with strafe.
+ */
 export class Client {
 
     public token: string | null = null;
@@ -11,6 +14,10 @@ export class Client {
         this.ws = new WebsocketClient(this);
     }
 
+    /**
+     * Logs the client in, establishing a WebSocket connection to strafe.
+     * @param token The bot token
+     */
     public async login(token: string) {
         this.token = token;
         this.ws.connect();

src/config/index.ts

@@ -1,8 +1,22 @@
 export const API = process.env.STRAFE_API ?? "https://equinox.strafe.chat/v1"
 export const GATEWAY = API + "/gateway";
 
+/**
+ * List of opcodes used for interacting with strafe.
+ */
 export enum OpCodes {
+    /**
+     * Op code used for sending an identify payload to Strafe.
+     */
     IDENTIFY = 0,
+
+    /**
+     * Op code used for receiving the hello event from Strafe.
+     */
     HELLO = 1,
+
+    /**
+     * Op code used for sending heartbeats to Strafe.
+     */
     HEARTBEAT = 2,
 }

src/index.ts

@@ -1,5 +1,6 @@
 export * from "./client/Client";
 export * from "./client/WebsocketClient";
 export * from "./config";
+export * from "./structure/ClientUser";
 export * from "./structure/User";
-export * from "./types";
+export * from "./types";

tsconfig.json

@@ -57,7 +57,7 @@
     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
     "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
+    "removeComments": false,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */

typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "includeVersion": true,
+    "entryPoints": ["./src/index.ts"],
+  }