Skip to content

Commit 326822b

Browse files
committed
chore(docs): more docs updates
1 parent 2d6bde2 commit 326822b

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"@std/cli": "jsr:@std/cli@^1.0.6",
66
"@std/io": "jsr:@std/io@^0.225.0"
77
},
8-
"version": "0.0.5",
8+
"version": "0.0.6",
99
"exports": "./mod.ts",
1010
"publish": {
1111
"include": ["README.md", "mod.ts", "src/"]

src/rcon.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ export class Rcon {
7474
/**
7575
* Authenticates the connection
7676
* @param password The RCON password
77+
*
78+
* @returns {Promise<boolean>} The result of the authentication
7779
*/
7880
public async authenticate(password: string): Promise<boolean> {
7981
if (!this.#connected) {
@@ -96,10 +98,12 @@ export class Rcon {
9698
}
9799

98100
/**
99-
* Executes command on the server
100-
* @param command Command to execute
101+
* Executes a command on the server
102+
* @param command The command to execute
103+
*
104+
* @returns {Promise<string>} The result of the execution
101105
*/
102-
public async execute(command: string): Promise<string | boolean> {
106+
public async execute(command: string): Promise<string> {
103107
if (!this.#connected) {
104108
throw new NotConnectedException();
105109
}

0 commit comments

Comments
 (0)