Skip to content

feat: Add a logout function for disposal of the client #163

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

Merged
Dadadah merged 2 commits into from
May 23, 2026
+12 −0
Merged

feat: Add a logout function for disposal of the client #163

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8786938
feat: Add a logout function for disposal of the client
Dadadah May 23, 2026
d89d090
fix: typo
Dadadah May 23, 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
12 changes: 12 additions & 0 deletions src/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,18 @@ export class Client extends AsyncEventEmitter<Events> {
this.connect();
}

/**
* Log out of current session
*
* This function prepares the client for disposal by removing all event listeners and killing the events socket.
*/
async logout(): Promise<void> {
await this.api.post("/auth/session/logout");
this.events.removeAllListeners();
this.removeAllListeners();
this.events.disconnect();
}

/**
* Prepare a markdown-based message to be displayed to the user as plain text.
* @param source Source markdown text
Expand Down
Loading