Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-10 16:43:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve some JSDocs

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-11-27 01:08:08 -05:00
parent 0d574a0678
commit dc6c1140bc
2 changed files with 36 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/client/Client.js
View File

@@ -443,11 +443,11 @@ module.exports = Client;
/**
* Emitted for general warnings
* @event Client#warn
* @param {string} The warning
* @param {string} info The warning
*/
/**
* Emitted for general debugging information
* @event Client#debug
* @param {string} The debug information
* @param {string} info The debug information
*/

74
src/util/Constants.js
View File

@@ -223,46 +223,40 @@ exports.Events = {
};
/**
* The type of a websocket message event, e.g. `MESSAGE_CREATE`.
* These can be accessed `Discord.Constants.WSEvents['MESSAGE_CREATE']`. Alternatively, you could just provide
* the string `MESSAGE_CREATE`.
*
* Here are the available events:
* ```js
* ["READY",
* "GUILD_SYNC",
* "GUILD_CREATE",
* "GUILD_DELETE",
* "GUILD_UPDATE",
* "GUILD_MEMBER_ADD",
* "GUILD_MEMBER_REMOVE",
* "GUILD_MEMBER_UPDATE",
* "GUILD_MEMBERS_CHUNK",
* "GUILD_ROLE_CREATE",
* "GUILD_ROLE_DELETE",
* "GUILD_ROLE_UPDATE",
* "GUILD_BAN_ADD",
* "GUILD_BAN_REMOVE",
* "CHANNEL_CREATE",
* "CHANNEL_DELETE",
* "CHANNEL_UPDATE",
* "CHANNEL_PINS_UPDATE",
* "MESSAGE_CREATE",
* "MESSAGE_DELETE",
* "MESSAGE_UPDATE",
* "MESSAGE_DELETE_BULK",
* "MESSAGE_REACTION_ADD",
* "MESSAGE_REACTION_REMOVE",
* "MESSAGE_REACTION_REMOVE_ALL",
* "USER_UPDATE",
* "USER_NOTE_UPDATE",
* "PRESENCE_UPDATE",
* "VOICE_STATE_UPDATE",
* "TYPING_START",
* "VOICE_SERVER_UPDATE",
* "RELATIONSHIP_ADD",
* "RELATIONSHIP_REMOVE"]
* ```
* The type of a websocket message event, e.g. `MESSAGE_CREATE`. Here are the available events:
* - READY
* - GUILD_SYNC
* - GUILD_CREATE
* - GUILD_DELETE
* - GUILD_UPDATE
* - GUILD_MEMBER_ADD
* - GUILD_MEMBER_REMOVE
* - GUILD_MEMBER_UPDATE
* - GUILD_MEMBERS_CHUNK
* - GUILD_ROLE_CREATE
* - GUILD_ROLE_DELETE
* - GUILD_ROLE_UPDATE
* - GUILD_BAN_ADD
* - GUILD_BAN_REMOVE
* - CHANNEL_CREATE
* - CHANNEL_DELETE
* - CHANNEL_UPDATE
* - CHANNEL_PINS_UPDATE
* - MESSAGE_CREATE
* - MESSAGE_DELETE
* - MESSAGE_UPDATE
* - MESSAGE_DELETE_BULK
* - MESSAGE_REACTION_ADD
* - MESSAGE_REACTION_REMOVE
* - MESSAGE_REACTION_REMOVE_ALL
* - USER_UPDATE
* - USER_NOTE_UPDATE
* - PRESENCE_UPDATE
* - VOICE_STATE_UPDATE
* - TYPING_START
* - VOICE_SERVER_UPDATE
* - RELATIONSHIP_ADD
* - RELATIONSHIP_REMOVE
* @typedef {string} WSEventType
*/
exports.WSEvents = {