some doc stuff idk

This commit is contained in:
Amish Shah
2016-08-13 12:25:01 +01:00
parent 0d53afe3ce
commit 53d767ec04
2 changed files with 57 additions and 0 deletions

View File

@@ -10,6 +10,13 @@ const ClientDataResolver = require('./ClientDataResolver');
const WebSocketManager = require('./websocket/WebSocketManager');
const ActionsManager = require('./actions/ActionsManager');
/**
* Creates a new Discord Client
* ```js
* const Discord = require("discord.js");
* const client = new Discord.Client();
* ```
*/
class Client extends EventEmitter{
constructor(options) {
@@ -23,6 +30,17 @@ class Client extends EventEmitter{
this.actions = new ActionsManager(this);
}
/**
* Logs the client in. If successful, resolves with the account's token.
* @param {string} emailOrToken The email or token used for the account. If it is an email, a password _must_ be
* provided.
* @param {string} [password] The password for the account, only needed if an email was provided.
* @return {Promise<String>}
* @example
* client.login("token");
* // or
* client.login("email", "password");
*/
login(email, password) {
if (password) {
// login with email and password
@@ -33,6 +51,10 @@ class Client extends EventEmitter{
}
}
/**
* The User of the logged in Client, only available after `READY` has been fired.
* @return {ClientUser} [description]
*/
get user() {
return this.store.user;
}

View File

@@ -2,6 +2,9 @@
const TextBasedChannel = require('./interface/TextBasedChannel');
/**
* Represents a User on Discord.
*/
class User {
constructor(client, data) {
this.client = client;
@@ -11,11 +14,39 @@ class User {
}
setup(data) {
/**
* The username of the User
* @type {String}
*/
this.username = data.username;
/**
* The ID of the User
* @type {String}
*/
this.id = data.id;
/**
* A discriminator based on username for the User
* @type {String}
*/
this.discriminator = data.discriminator;
/**
* The ID of the user's avatar
* @type {String}
*/
this.avatar = data.avatar;
/**
* Whether or not the User is a Bot.
* @type {Boolean}
*/
this.bot = Boolean(data.bot);
/**
* The status of the user:
*
* * **`online`** - user is online
* * **`offline`** - user is offline
* * **`idle`** - user is AFK
* @type {String}
*/
this.status = data.status || this.status || 'offline';
this.game = data.game || this.game;
}
@@ -24,6 +55,10 @@ class User {
return `<@${this.id}>`;
}
/**
* Deletes a DM Channel (if one exists) between the Client and the User. Resolves with the Channel if successful.
* @return {Promise<DMChannel>}
*/
deleteDM() {
return this.client.rest.methods.DeleteChannel(this);
}