Skip to content

Add some notes that Client.connect() should be called after Client.login() #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Taureon wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −2
Open

Add some notes that Client.connect() should be called after Client.login() #140

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
157c5f5
Update Client.ts: Add documentation that Client.connect() should be c…
Taureon Mar 11, 2026
c068a8b
i put a dot here for some reason
Taureon Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,8 @@ export class Client extends AsyncEventEmitter<Events> {
}

/**
* Connect to Revolt
* Connect to Revolt.
* To be called after `client.login`'s `Promise` resolves
*/
connect(): void {
clearTimeout(this.#reconnectTimeout);
Expand Down Expand Up @@ -362,6 +363,7 @@ export class Client extends AsyncEventEmitter<Events> {

/**
* 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
*/
Expand All @@ -385,7 +387,8 @@ export class Client extends AsyncEventEmitter<Events> {
}

/**
* Log in as a bot
* Log in as a bot.
* Automatically connects
* @param token Bot token
*/
async loginBot(token: string): Promise<void> {
Expand Down