Skip to content

docs(Client): fix docs for login method #4350

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
merged 4 commits into from
Aug 11, 2020
Merged

docs(Client): fix docs for login method #4350

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
857f0c2
docs(Client): fix docs for login method
vaporoxx Jun 11, 2020
9e00b39
docs: add info tag
vaporoxx Jun 11, 2020
82abcff
docs: set default for token and move description
vaporoxx Jun 11, 2020
4a54ed6
Update src/client/Client.js
vaporoxx Aug 11, 2020
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
5 changes: 3 additions & 2 deletions src/client/Client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ class Client extends BaseClient {
Object.defineProperty(this, 'token', { writable: true });
if (!browser && !this.token && 'DISCORD_TOKEN' in process.env) {
/**
* Authorization token for the logged in bot
* Authorization token for the logged in bot.
* If present, this defaults to `process.env.DISCORD_TOKEN` when instantiating the client
* <warn>This should be kept private at all times.</warn>
* @type {?string}
*/
Expand Down Expand Up @@ -195,7 +196,7 @@ class Client extends BaseClient {

/**
* Logs the client in, establishing a websocket connection to Discord.
* @param {string} token Token of the account to log in with
* @param {string} [token=this.token] Token of the account to log in with
* @returns {Promise<string>} Token of the account used
* @example
* client.login('my token');
Expand Down