diff --git a/src/Client.ts b/src/Client.ts index 3119525c..168a9eeb 100644 --- a/src/Client.ts +++ b/src/Client.ts @@ -326,7 +326,8 @@ export class Client extends AsyncEventEmitter { } /** - * Connect to Revolt + * Connect to Revolt. + * To be called after `client.login`'s `Promise` resolves */ connect(): void { clearTimeout(this.#reconnectTimeout); @@ -362,6 +363,7 @@ export class Client extends AsyncEventEmitter { /** * Log in with auth data, creating a new session in the process. + * Does not automatically connect. A call to `Client.connect()` is required after this `Promise` resolves * @param details Login data object * @returns An on-boarding function if on-boarding is required, undefined otherwise */ @@ -385,7 +387,8 @@ export class Client extends AsyncEventEmitter { } /** - * Log in as a bot + * Log in as a bot. + * Automatically connects * @param token Bot token */ async loginBot(token: string): Promise {