From 326822ba2930b38559ab1ca6ec07df74f554eef6 Mon Sep 17 00:00:00 2001 From: c43721 Date: Sat, 2 Nov 2024 13:23:28 -0500 Subject: [PATCH] chore(docs): more docs updates --- deno.json | 2 +- src/rcon.ts | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/deno.json b/deno.json index 01e643f..f97c2c0 100644 --- 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 index 543aa8a..af03b0a 100644 --- 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} The result of the authentication */ public async authenticate(password: string): Promise { 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} The result of the execution */ - public async execute(command: string): Promise { + public async execute(command: string): Promise { if (!this.#connected) { throw new NotConnectedException(); }