From 9969c5453650a22c7ea18befc4f57fe8edb27db9 Mon Sep 17 00:00:00 2001 From: Androz2091 Date: Sat, 16 Jan 2021 10:00:12 +0100 Subject: [PATCH] :sparkles: Generate docs and tests --- docs/index.html | 323 +++++++++++++++++++++++++++++++++++++++--------- tests/test.js | 18 ++- 2 files changed, 280 insertions(+), 61 deletions(-) diff --git a/docs/index.html b/docs/index.html index 81cfa9b..c179525 100644 --- a/docs/index.html +++ b/docs/index.html @@ -726,10 +726,107 @@

- guildFeaturesUpdate + guildVanityURLRemove

+
📡 Emitted when a guild removes its vanity URL.
+
ℹ️ Parameters: +

+ + + + + + + + + + + + + + + + + + + +
NameTypeDescription
guild + + Guild + The guild which removed its vanity URL.
vanityURL + + string + The vanity url.
+
🆘 Example:
client.on("guildVanityURLRemove", (guild, vanityURL) => {
+  console.log(guild.name+" has removed its vanity url : "+vanityURL);
+});
+
+
+
+ +
+
+
+

+ guildVanityURLUpdate +

+
+
+
📡 Emitted when a guild updates its vanity URL.
+
ℹ️ Parameters: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
guild + + Guild + The guild which updated a vanity URL.
oldVanityURL + + string + The former vanity URL.
vanityURL + + string + The updated vanity URL.
+
🆘 Example:
client.on("guildVanityURLUpdate", (guild, oldVanityURL, newVanityURL) => {
+  console.log(`${guild.name} has changed its vanity URL from ${oldGuildvanityURL} to ${newGuildvanityURL} !`);
+});
+
+
+
+
+
+
+
+

+ guildFeaturesUpdate +

+
+
📡 Emitten when a guild feature gets updated.
ℹ️ Parameters:

@@ -770,10 +867,10 @@

- guildAcronymUpdate + guildAcronymUpdate

-
+
📡 Emitted when a guild updates its Acronym.
ℹ️ Parameters:

@@ -814,10 +911,10 @@

- guildOwnerUpdate + guildOwnerUpdate

-
+
📡 Emitted when a guild updates its owner.
ℹ️ Parameters:

@@ -858,10 +955,10 @@

- guildPartnerAdd + guildPartnerAdd

-
+
📡 Emitted when a guild gets partnered.
ℹ️ Parameters:

@@ -893,10 +990,10 @@

- guildPartnerRemove + guildPartnerRemove

-
+
📡 Emitted when a guild is no longer partnered.
ℹ️ Parameters:

@@ -928,10 +1025,10 @@

- guildVerificationAdd + guildVerificationAdd

-
+
📡 Emitted when a guild gets verified.
ℹ️ Parameters:

@@ -963,10 +1060,10 @@

- guildVerificationRemove + guildVerificationRemove

-
+
📡 Emitted when a guild is no longer verified.
ℹ️ Parameters:

@@ -998,10 +1095,10 @@

- unhandledGuildUpdate + unhandledGuildUpdate

-
+
📡 Emitted when the guildUpdate event is triggered but discord-logs didn't trigger any custom event.
ℹ️ Parameters:

@@ -1044,10 +1141,10 @@
Events related to the messageUpdate event.

- messagePinned + messagePinned

-
+
📡 Emitted when a message has been pinned.
ℹ️ Parameters:

@@ -1079,10 +1176,10 @@

- messageContentEdited + messageContentEdited

-
+
📡 Emitted when a message content has been edited.
ℹ️ Parameters:

@@ -1132,10 +1229,10 @@

- unhandledMessageUpdate + unhandledMessageUpdate

-
+
📡 Emitted when the messageUpdate event is triggered but discord-logs didn't trigger any custom event.
ℹ️ Parameters:

@@ -1178,10 +1275,10 @@
Events related to the presenceUpdate event.

- guildMemberOffline + guildMemberOffline

-
+
📡 Emitted when a member becomes offline.
ℹ️ Parameters:

@@ -1222,10 +1319,10 @@

- guildMemberOnline + guildMemberOnline

-
+
📡 Emitted when a member becomes online, dnd or idle.
ℹ️ Parameters:

@@ -1266,10 +1363,10 @@

- unhandledPresenceUpdate + unhandledPresenceUpdate

-
+
📡 Emitted when the presenceUpdate event is triggered but discord-logs didn't trigger any custom event.
ℹ️ Parameters:

@@ -1312,10 +1409,10 @@
Events related to the roleUpdate event.

- rolePositionUpdate + rolePositionUpdate

-
+
📡 Emitted when a role position changes.
ℹ️ Parameters:

@@ -1365,10 +1462,63 @@

- unhandledRoleUpdate + rolePermissionsUpdate

-
+
+
📡 Emitted when a role permissions changes.
+
ℹ️ Parameters: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
role + + Role + The role whose permissions has changed.
oldPermissions + + number + The old role permissions.
newPermissions + + number + The new role permissions.
+
🆘 Example:
client.on("rolePermissionsUpdate", (role, oldPermissions, newPermissions) => {
+  console.log(role.name + " had as permissions "+oldPermissions+" and now has as permissions "+newPermissions);
+});
+
+
+
+
+
+
+
+

+ unhandledRoleUpdate +

+
+
📡 Emitted when the roleUpdate event is triggered but discord-logs didn't trigger any custom event.
ℹ️ Parameters:

@@ -1411,10 +1561,10 @@
Events related to the userUpdate event.

- userAvatarUpdate + userAvatarUpdate

-
+
📡 Emitted when a user changes their avatar.
ℹ️ Parameters:

@@ -1464,10 +1614,10 @@

- userUsernameUpdate + userUsernameUpdate

-
+
📡 Emitted when a user changes their username.
ℹ️ Parameters:

@@ -1517,10 +1667,10 @@

- userDiscriminatorUpdate + userDiscriminatorUpdate

-
+
📡 Emitted when a user changes their discriminator.
ℹ️ Parameters:

@@ -1559,7 +1709,7 @@

-
🆘 Example:
client.on("userUsernameUpdate", (user, oldDiscriminator, newDiscriminator) => {
+                      
🆘 Example:
client.on("userDiscriminatorUpdate", (user, oldDiscriminator, newDiscriminator) => {
   console.log(user.tag+" discriminator updated!");
 });
 

@@ -1570,10 +1720,63 @@ 

                     

                     

                         

-                            unhandledUserUpdate
+                            userFlagsUpdate
                         

                     

-                    

+                    

+                        
📡 Emitted when a user changes their flags.

+                        
ℹ️ Parameters: 
+                        


+                        
+                        
+                            
+                            
+                            
+                        
+                        
+                        
+                            
+                            
+                            
+                        
+                        
+                        
+                            
+                            
+                            
+                        
+                        
+                        
+                            
+                            
+                            
+                        
+                        
+                      
NameTypeDescription
 user 
+                                
+                                User
+                             The user who changed their flags. 
 oldFlags 
+                                
+                                string
+                             The old flags. 
 newFlags 
+                                
+                                string
+                             The new flags. 

+                      
🆘 Example:
client.on("userFlagsUpdate", (user, oldFlags, newFlags) => {
+  console.log(user.tag+" flags updated!");
+});
+

+                    

+                    

+                

+                

+                    

+                    

+                        

+                            unhandledUserUpdate
+                        

+                    

+                    

                         
📡 Emitted when the userUpdate event is triggered but discord-logs didn't trigger any custom event.

                         
ℹ️ Parameters: 
                         


@@ -1616,10 +1819,10 @@ 
Events related to the voiceStateUpdate event.


                     

                     

                         

-                            voiceChannelJoin
+                            voiceChannelJoin
                         

                     

-                    

+                    

                         
📡 Emitted when a member joins a voice channel.

                         
ℹ️ Parameters: 
                         


@@ -1660,10 +1863,10 @@ 

                     

                     

                         

-                            voiceChannelLeave
+                            voiceChannelLeave
                         

                     

-                    

+                    

                         
📡 Emitted when a member leaves a voice channel.

                         
ℹ️ Parameters: 
                         


@@ -1704,10 +1907,10 @@ 

                     

                     

                         

-                            voiceChannelSwitch
+                            voiceChannelSwitch
                         

                     

-                    

+                    

                         
📡 Emitted when a member switches to another voice channel.

                         
ℹ️ Parameters: 
                         


@@ -1757,10 +1960,10 @@ 

                     

                     

                         

-                            voiceChannelMute
+                            voiceChannelMute
                         

                     

-                    

+                    

                         
📡 Emitted when a member becomes muted (self-muted or server-muted).

                         
ℹ️ Parameters: 
                         


@@ -1801,10 +2004,10 @@ 

                     

                     

                         

-                            voiceChannelUnmute
+                            voiceChannelUnmute
                         

                     

-                    

+                    

                         
📡 Emitted when a member becomes unmuted.

                         
ℹ️ Parameters: 
                         


@@ -1845,10 +2048,10 @@ 

                     

                     

                         

-                            voiceChannelDeaf
+                            voiceChannelDeaf
                         

                     

-                    

+                    

                         
📡 Emitted when a member becomes deafed.

                         
ℹ️ Parameters: 
                         


@@ -1889,10 +2092,10 @@ 

                     

                     

                         

-                            voiceChannelUndeaf
+                            voiceChannelUndeaf
                         

                     

-                    

+                    

                         
📡 Emitted when a member becomes undeafed.

                         
ℹ️ Parameters: 
                         


@@ -1933,10 +2136,10 @@ 

                     

                     

                         

-                            voiceStreamingStart
+                            voiceStreamingStart
                         

                     

-                    

+                    

                         
📡 Emitted when a member starts streaming.

                         
ℹ️ Parameters: 
                         


@@ -1977,10 +2180,10 @@ 

                     

                     

                         

-                            voiceStreamingStop
+                            voiceStreamingStop
                         

                     

-                    

+                    

                         
📡 Emitted when a member stops streaming.

                         
ℹ️ Parameters: 
                         


@@ -2021,10 +2224,10 @@ 

                     

                     

                         

-                            unhandledVoiceStateUpdate
+                            unhandledVoiceStateUpdate
                         

                     

-                    

+                    

                         
📡 Emitted when the voiceStateUpdate event is triggered but discord-logs didn't trigger any custom event.

                         
ℹ️ Parameters: 
                         


diff --git a/tests/test.js b/tests/test.js
index 79a8f29..7716da1 100644
--- a/tests/test.js
+++ b/tests/test.js
@@ -78,6 +78,14 @@ client.on("guildVanityURLAdd", (guild, vanityURL) => {
   console.log(guild.name+" has added a vanity url : "+vanityURL);
 });
 
+client.on("guildVanityURLRemove", (guild, vanityURL) => {
+  console.log(guild.name+" has removed its vanity url : "+vanityURL);
+});
+
+client.on("guildVanityURLUpdate", (guild, oldVanityURL, newVanityURL) => {
+  console.log(`${guild.name} has changed its vanity URL from ${oldGuildvanityURL} to ${newGuildvanityURL} !`);
+});
+
 client.on("guildFeaturesUpdate", (oldGuild, newGuild) => {
   console.log(`New features: ${newGuild.features.join(", ")}`);
 });
@@ -147,6 +155,10 @@ client.on("rolePositionUpdate", (role, oldPosition, newPosition) => {
   console.log(role.name + " was at position "+oldPosition+" and now is at position "+newPosition);
 });
 
+client.on("rolePermissionsUpdate", (role, oldPermissions, newPermissions) => {
+  console.log(role.name + " had as permissions "+oldPermissions+" and now has as permissions "+newPermissions);
+});
+
 client.on("unhandledRoleUpdate", (oldRole, newRole) => {
   console.log("Role '"+oldRole.id+"' was updated but discord-logs couldn't find what was updated...");
 });
@@ -162,10 +174,14 @@ client.on("userUsernameUpdate", (user, oldUsername, newUsername) => {
   console.log(user.tag+" username updated!");
 });
 
-client.on("userUsernameUpdate", (user, oldDiscriminator, newDiscriminator) => {
+client.on("userDiscriminatorUpdate", (user, oldDiscriminator, newDiscriminator) => {
   console.log(user.tag+" discriminator updated!");
 });
 
+client.on("userFlagsUpdate", (user, oldFlags, newFlags) => {
+  console.log(user.tag+" flags updated!");
+});
+
 client.on("unhandledUserUpdate", (oldUser, newUser) => {
   console.log("User '"+oldUser.id+"' was updated but discord-logs couldn't find what was updated...");
 });