chore(docs): more docs updates

rcontf · Nov 2, 2024 · 326822b · 326822b
1 parent 2d6bde2
commit 326822b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/deno.json b/deno.json
@@ -5,7 +5,7 @@
     "@std/cli": "jsr:@std/cli@^1.0.6",
     "@std/io": "jsr:@std/io@^0.225.0"
   },
-  "version": "0.0.5",
+  "version": "0.0.6",
   "exports": "./mod.ts",
   "publish": {
     "include": ["README.md", "mod.ts", "src/"]

diff --git a/src/rcon.ts b/src/rcon.ts
@@ -74,6 +74,8 @@ export class Rcon {
   /**
    * Authenticates the connection
    * @param password The RCON password
+   * 
+   * @returns {Promise<boolean>} The result of the authentication
    */
   public async authenticate(password: string): Promise<boolean> {
     if (!this.#connected) {
@@ -96,10 +98,12 @@ export class Rcon {
   }
 
   /**
-   * Executes command on the server
-   * @param command Command to execute
+   * Executes a command on the server
+   * @param command The command to execute
+   * 
+   * @returns {Promise<string>} The result of the execution
    */
-  public async execute(command: string): Promise<string | boolean> {
+  public async execute(command: string): Promise<string> {
     if (!this.#connected) {
       throw new NotConnectedException();
     }