Document all the events

src/client/websocket/packets/handlers/ChannelCreate.js

@@ -17,4 +17,11 @@ class ChannelCreateHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a Channel is created.
+*
+* @event Client#channelCreate
+* @param {Channel} channel The channel that was created
+*/
+
 module.exports = ChannelCreateHandler;

src/client/websocket/packets/handlers/ChannelDelete.js

@@ -17,4 +17,11 @@ class ChannelDeleteHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a Channel is deleted.
+*
+* @event Client#channelDelete
+* @param {Channel} channel The channel that was deleted
+*/
+
 module.exports = ChannelDeleteHandler;

src/client/websocket/packets/handlers/GuildBanAdd.js

@@ -19,4 +19,12 @@ class GuildBanAddHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a member is banned from a guild.
+*
+* @event Client#guildBanAdd
+* @param {Guild} guild The guild that the ban occurred in
+* @param {User} user The user that was banned
+*/
+
 module.exports = GuildBanAddHandler;

src/client/websocket/packets/handlers/GuildBanRemove.js

@@ -20,4 +20,12 @@ class GuildBanRemoveHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a member is unbanned from a guild.
+*
+* @event Client#guildBanRemove
+* @param {Guild} guild The guild that the unban occurred in
+* @param {User} user The user that was unbanned
+*/
+
 module.exports = GuildBanRemoveHandler;

src/client/websocket/packets/handlers/GuildDelete.js

@@ -16,4 +16,11 @@ class GuildDeleteHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a Guild is deleted/left.
+*
+* @event Client#guildDelete
+* @param {Guild} guild The guild that was deleted
+*/
+
 module.exports = GuildDeleteHandler;

src/client/websocket/packets/handlers/GuildMembersChunk.js

@@ -22,4 +22,12 @@ class GuildMembersChunkHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a chunk of Guild members is received
+*
+* @event Client#guildMembersChunk
+* @param {Guild} guild The guild that the chunks relate to
+* @param {Array<GuildMember>} members The members in the chunk
+*/
+
 module.exports = GuildMembersChunkHandler;

src/client/websocket/packets/handlers/MessageCreate.js

@@ -16,4 +16,11 @@ class MessageCreateHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a message is created
+*
+* @event Client#message
+* @param {Message} message The created message
+*/
+
 module.exports = MessageCreateHandler;

src/client/websocket/packets/handlers/MessageDelete.js

@@ -16,4 +16,11 @@ class MessageDeleteHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a message is deleted
+*
+* @event Client#messageDelete
+* @param {Message} message The deleted message
+*/
+
 module.exports = MessageDeleteHandler;

src/client/websocket/packets/handlers/PresenceUpdate.js

@@ -63,4 +63,21 @@ class PresenceUpdateHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a user changes one of their details or starts/stop playing a game
+*
+* @event Client#presenceUpdate
+* @param {User} oldUser the user before the presence update
+* @param {User} newUser the user after the presence update
+*/
+
+/**
+* Emitted whenever a member becomes available in a large Guild
+*
+* @event Client#guildMemberAvailable
+* @param {Guild} guild The guild that the member became available in
+* @param {GuildMember} member the member that became available
+*/
+
+
 module.exports = PresenceUpdateHandler;

src/client/websocket/packets/handlers/TypingStart.js

@@ -49,4 +49,20 @@ class TypingStartHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a user starts typing in a channel
+*
+* @event Client#typingStart
+* @param {Channel} channel the channel the user started typing in
+* @param {User} user the user that started typing
+*/
+
+/**
+* Emitted whenever a user stops typing in a channel
+*
+* @event Client#typingStop
+* @param {Channel} channel the channel the user stopped typing in
+* @param {User} user the user that stopped typing
+*/
+
 module.exports = TypingStartHandler;

src/client/websocket/packets/handlers/VoiceStateUpdate.js

@@ -31,4 +31,12 @@ class VoiceStateUpdateHandler extends AbstractHandler {
 
 }
 
+/**
+* Emitted whenever a user changes voice state - e.g. joins/leaves a channel, mutes/unmutes.
+*
+* @event Client#voiceStateUpdate
+* @param {GuildMember} oldMember the member before the voice state update
+* @param {GuildMember} newMember the member before the voice state update
+*/
+
 module.exports = VoiceStateUpdateHandler;