├── .github
└── FUNDING.yml
├── README.md
└── cheatsheet.js
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: [armfxl]
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
5 |
6 |
7 | ## Discord.js Cheatsheet
8 |
9 | This guide will go over all of the Discord.js events and how to use them, along with examples. You can use this information in many ways, but the most common would be creating a log system for your Discord bot. I don't suggest just copy pasting, try implementing this with your own code. Happy reading!
10 |
11 | If you want to just copy the code you can do so **[here](https://github.com/armfxl/discord.js-cheatsheet/blob/main/cheatsheet.js)**.
12 |
13 | ### Content:
14 |
15 | - **[Channel Events](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#channel-events)**
16 | - [channelCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#channelCreate)
17 | - [channelDelete](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#channelDelete)
18 | - [channelPinsUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#channelPinsUpdate)
19 | - [channelUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#channelUpdate)
20 | - **[Client User Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#client-user-events)**
21 | - [clientUserGuildSettingsUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#clientUserGuildSettingsUpdate)
22 | - [clientUserSettingsUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#clientUserSettingsUpdate)
23 | - **[Debug Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#debug-events)**
24 | - [debug](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#debug)
25 | - **[Error Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#error-events)**
26 | - [error](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#error)
27 | - [warn](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#warn)
28 | - **[WebSocket Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#websocket-events)**
29 | - [disconnect](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#disconnect)
30 | - [reconnecting](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#reconnecting)
31 | - [resume](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#resume)
32 | - **[Emoji Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#emoji-events)**
33 | - [emojiCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#emojiCreate)
34 | - [emojiDelete](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#emojiDelete)
35 | - [emojiUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#emojiUpdate)
36 | - **[Guild Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guild-events)**
37 | - [guildBanAdd](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildBanAdd)
38 | - [guildBanRemove](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildBanRemove)
39 | - [guildCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildCreate)
40 | - [guildDelete](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildDelete)
41 | - [guildUnavailable](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMemberSpeaking)
42 | - [guildUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildUpdate)
43 | - **[Guild Member Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guild-events)**
44 | - [guildMemberAdd](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMemberAdd)
45 | - [guildMemberAvailable](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMemberAvailable)
46 | - [guildMemberRemove](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMemberRemove)
47 | - [guildMembersChunk](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMembersChunk)
48 | - [guildMemberUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#presenceUpdate)
49 | - [presenceUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#guildMemberUpdate)
50 | - **[Interaction Event:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#interacation-event)**
51 | - [interactionCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#interactionCreate)
52 | - **[Message Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#message-events)**
53 | - [messageCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageCreate)
54 | - [messageDelete](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageDelete)
55 | - [messageDeleteBulk](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageDeleteBulk)
56 | - [messageReactionAdd](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageReactionAdd)
57 | - [messageReactionRemove](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageReactionRemove)
58 | - [messageReactionRemoveAll](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageReactionRemoveAll)
59 | - [messageUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#messageUpdate)
60 | - [typingStart](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#typingStart)
61 | - [typingStop](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#typingStop)
62 | - **[Client Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#client-events)**
63 | - [ready](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#ready)
64 | - **[Role Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#role-events)**
65 | - [roleCreate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#roleCreate)
66 | - [roleDelete](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#roleDelete)
67 | - [roleUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#roleUpdate)
68 | - **[User Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#user-events)**
69 | - [userNoteUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#userNoteUpdate)
70 | - [userUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#userUpdate)
71 | - **[Voice Events:](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#voice-events)**
72 | - [voiceStateUpdate](https://github.com/armfxl/discord.js-cheatsheet/blob/main/README.md#voiceStateUpdate)
73 |
74 | ## Channel Events:
75 |
76 | ### channelCreate
77 |
78 | ##### Emitted whenever a channel is created.
79 |
80 | ```js
81 | // PARAMETER TYPE DESCRIPTION
82 | // channel Channel The channel that was created
83 |
84 | client.on('channelCreate', function (channel) {
85 | console.log(`channelCreate: ${channel}`);
86 | });
87 | ```
88 |
89 | ### channelDelete
90 |
91 | #### Emitted whenever a channel is deleted.
92 |
93 | ```js
94 | // PARAMETER TYPE DESCRIPTION
95 | // channel Channel The channel that was deleted
96 |
97 | client.on('channelDelete', function (channel) {
98 | console.log(`channelDelete: ${channel}`);
99 | });
100 | ```
101 |
102 | ### channelPinsUpdate
103 |
104 | ##### Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information can be provided easily here.
105 |
106 | ```js
107 | // PARAMETER TYPE DESCRIPTION
108 | // channel Channel The channel that the pins update occurred in
109 | // time Date The time of the pins update
110 |
111 | client.on('channelPinsUpdate', function (channel, time) {
112 | console.log(`channelPinsUpdate: ${channel}:${time}`);
113 | });
114 | ```
115 |
116 | ### channelUpdate
117 |
118 | ##### Emitted whenever a channel is updated - e.g. name change, topic change.
119 |
120 | ```js
121 | // PARAMETER TYPE DESCRIPTION
122 | // oldChannel Channel The channel before the update
123 | // newChannel Channel The channel after the update
124 |
125 | client.on('channelUpdate', function (oldChannel, newChannel) {
126 | console.log(`channelUpdate -> a channel is updated - e.g. name change, topic change`);
127 | });
128 | ```
129 |
130 | ## Client User Events:
131 |
132 | ### clientUserGuildSettingsUpdate
133 |
134 | ##### Emitted whenever the client user's settings update.
135 |
136 | ```js
137 | // PARAMETER TYPE DESCRIPTION
138 | // clientUserGuildSettings ClientUserGuildSettings The new client user guild settings
139 |
140 | client.on('clientUserGuildSettingsUpdate', function (clientUserGuildSettings) {
141 | console.log(`clientUserGuildSettingsUpdate -> client user's settings update`);
142 | });
143 | ```
144 |
145 | ### clientUserSettingsUpdate
146 |
147 | ##### Emitted when the client user's settings update.
148 |
149 | ```js
150 | // PARAMETER TYPE DESCRIPTION
151 | // clientUserSettings ClientUserSettings The new client user settings
152 |
153 | client.on('clientUserSettingsUpdate', function (clientUserSettings) {
154 | console.log(`clientUserSettingsUpdate -> client user's settings update`);
155 | });
156 | ```
157 |
158 | ## Debug Events:
159 |
160 | ### debug
161 |
162 | ##### Emitted for general debugging information.
163 |
164 | ```js
165 | // PARAMETER TYPE DESCRIPTION
166 | // info string The debug information
167 |
168 | client.on('debug', function (info) {
169 | console.log(`debug -> ${info}`);
170 | });
171 | ```
172 |
173 | ## Error Events:
174 |
175 | ### error
176 |
177 | ##### Emitted whenever the client's WebSocket encounters a connection error.
178 |
179 | ```js
180 | // PARAMETER TYPE DESCRIPTION
181 | // error Error The encountered error
182 |
183 | client.on('error', function (error) {
184 | console.error(`client's WebSocket encountered a connection error: ${error}`);
185 | });
186 | ```
187 |
188 | ### warn
189 |
190 | ##### Emitted for general warnings.
191 |
192 | ```js
193 | // PARAMETER TYPE DESCRIPTION
194 | // info string The warning
195 |
196 | client.on('warn', function (info) {
197 | console.log(`warn: ${info}`);
198 | });
199 | ```
200 |
201 | ## WebSocket Events:
202 |
203 | ### disconnect
204 |
205 | ##### Emitted when the client's WebSocket disconnects and will no longer attempt to reconnect.
206 |
207 | ```js
208 | // PARAMETER TYPE DESCRIPTION
209 | // Event CloseEvent The WebSocket close event
210 |
211 | client.on('disconnect', function (event) {
212 | console.log(`The WebSocket has closed and will no longer attempt to reconnect`);
213 | });
214 | ```
215 |
216 | ### reconnecting
217 |
218 | ##### Emitted whenever the client tries to reconnect to the WebSocket.
219 |
220 | ```js
221 | client.on('reconnecting', function () {
222 | console.log(`client tries to reconnect to the WebSocket`);
223 | });
224 | ```
225 |
226 | ### resume
227 |
228 | ##### Emitted whenever a WebSocket resumes.
229 |
230 | ```js
231 | // PARAMETER TYPE DESCRIPTION
232 | // replayed number The number of events that were replayed
233 |
234 | client.on('resume', function (replayed) {
235 | console.log(`whenever a WebSocket resumes, ${replayed} replays`);
236 | });
237 | ```
238 |
239 | ## Emoji Events:
240 |
241 | ### emojiCreate
242 |
243 | ##### Emitted whenever a custom emoji is created in a guild.
244 |
245 | ```js
246 | // PARAMETER TYPE DESCRIPTION
247 | // emoji Emoji The emoji that was created
248 |
249 | client.on('emojiCreate', function (emoji) {
250 | console.log(`a custom emoji is created in a guild`);
251 | });
252 | ```
253 |
254 | ### emojiDelete
255 |
256 | ##### Emitted whenever a custom guild emoji is deleted.
257 |
258 | ```js
259 | // PARAMETER TYPE DESCRIPTION
260 | // emoji Emoji The emoji that was deleted
261 |
262 | client.on('emojiDelete', function (emoji) {
263 | console.log(`a custom guild emoji is deleted`);
264 | });
265 | ```
266 |
267 | ### emojiUpdate
268 |
269 | ##### Emitted whenever a custom guild emoji is updated.
270 |
271 | ```js
272 | // PARAMETER TYPE DESCRIPTION
273 | // oldEmoji Emoji The old emoji
274 | // newEmoji Emoji The new emoji
275 |
276 | client.on('emojiUpdate', function (oldEmoji, newEmoji) {
277 | console.log(`a custom guild emoji is updated`);
278 | });
279 | ```
280 |
281 | ## Guild Events:
282 |
283 | ### guildBanAdd
284 |
285 | ##### Emitted whenever a member is banned from a guild.
286 |
287 | ```js
288 | // PARAMETER TYPE DESCRIPTION
289 | // guild Guild The guild that the ban occurred in
290 | // user User The user that was banned
291 |
292 | client.on('guildBanAdd', function (guild, user) {
293 | console.log(`a member is banned from a guild`);
294 | });
295 | ```
296 |
297 | ### guildBanRemove
298 |
299 | ##### Emitted whenever a member is unbanned from a guild.
300 |
301 | ```js
302 | // PARAMETER TYPE DESCRIPTION
303 | // guild Guild The guild that the unban occurred in
304 | // user User The user that was unbanned
305 |
306 | client.on('guildBanRemove', function (guild, user) {
307 | console.log(`a member is unbanned from a guild`);
308 | });
309 | ```
310 |
311 | ### guildCreate
312 |
313 | ##### Emitted whenever the client joins a guild.
314 |
315 | ```js
316 | // PARAMETER TYPE DESCRIPTION
317 | // guild Guild The created guild
318 |
319 | client.on('guildCreate', function (guild) {
320 | console.log(`the client joins a guild`);
321 | });
322 | ```
323 |
324 | ### guildDelete
325 |
326 | #### Emitted whenever a guild is deleted/left.
327 |
328 | ```js
329 | // PARAMETER TYPE DESCRIPTION
330 | // guild Guild The guild that was deleted
331 |
332 | client.on('guildDelete', function (guild) {
333 | console.log(`the client deleted/left a guild`);
334 | });
335 | ```
336 |
337 | ### guildUnavailable
338 |
339 | ##### Emitted whenever a guild becomes unavailable, likely due to a server outage.
340 |
341 | ```js
342 | // PARAMETER TYPE DESCRIPTION
343 | // guild Guild The guild that has become unavailable
344 |
345 | client.on('guildUnavailable', function (guild) {
346 | console.error(`a guild becomes unavailable, likely due to a server outage: ${guild}`);
347 | });
348 | ```
349 |
350 | ### guildUpdate
351 |
352 | ##### Emitted whenever a guild is updated - e.g. name change.
353 |
354 | ```js
355 | // PARAMETER TYPE DESCRIPTION
356 | // oldGuild Guild The guild before the update
357 | // newGuild Guild The guild after the update
358 |
359 | client.on('guildUpdate', function (oldGuild, newGuild) {
360 | console.error(`a guild is updated`);
361 | });
362 | ```
363 |
364 | ## Guild Member Events:
365 |
366 | ### guildMemberAdd
367 |
368 | #### Emitted whenever a user joins a guild.
369 |
370 | ```js
371 | // PARAMETER TYPE DESCRIPTION
372 | // member GuildMember The member that has joined a guild
373 |
374 | client.on('guildMemberAdd', function (member) {
375 | console.log(`a user joins a guild: ${member.tag}`);
376 | });
377 | ```
378 |
379 | ### guildMemberAvailable
380 |
381 | ##### Emitted whenever a member becomes available in a large guild.
382 |
383 | ```js
384 | // PARAMETER TYPE DESCRIPTION
385 | // member GuildMember The member that became available
386 |
387 | client.on('guildMemberAvailable', function (member) {
388 | console.log(`member becomes available in a large guild: ${member.tag}`);
389 | });
390 | ```
391 |
392 | ### guildMemberRemove
393 |
394 | ##### Emitted whenever a member leaves a guild, or is kicked.
395 |
396 | ```js
397 | // PARAMETER TYPE DESCRIPTION
398 | // member GuildMember The member that has left/been kicked from the guild
399 |
400 | client.on('guildMemberRemove', function (member) {
401 | console.log(`a member leaves a guild, or is kicked: ${member.tag}`);
402 | });
403 | ```
404 |
405 | ### guildMembersChunk
406 |
407 | ##### Emitted whenever a chunk of guild members is received (all members come from the same guild).
408 |
409 | ```js
410 | // PARAMETER TYPE DESCRIPTION
411 | // members Array The members in the chunk
412 | // guild Guild The guild related to the member chunk
413 |
414 | client.on('guildMembersChunk', function (members, guild) {
415 | console.error(`a chunk of guild members is received`);
416 | });
417 | ```
418 |
419 | ### guildMemberUpdate
420 |
421 | ##### Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
422 |
423 | ```js
424 | // PARAMETER TYPE DESCRIPTION
425 | // oldMember GuildMember The member before the update
426 | // newMember GuildMember The member after the update
427 |
428 | client.on('guildMemberUpdate', function (oldMember, newMember) {
429 | console.error(`a guild member changes - i.e. new role, removed role, nickname.`);
430 | });
431 | ```
432 |
433 | ### presenceUpdate
434 |
435 | ##### Emitted whenever a guild member's presence changes, or they change one of their details.
436 |
437 | ```js
438 | // PARAMETER TYPE DESCRIPTION
439 | // oldMember GuildMember The member before the presence update
440 | // newMember GuildMember The member after the presence update
441 |
442 | client.on('presenceUpdate', function (oldMember, newMember) {
443 | console.log(`a guild member's presence changes`);
444 | });
445 | ```
446 |
447 | ## Interaction Event:
448 |
449 | ### interactionCreate
450 |
451 | ##### Emitted when an interaction is created.
452 |
453 | ```js
454 | // PARAMETER TYPE DESCRIPTION
455 | // interaction Interaction The interaction which was created
456 |
457 | client.on('interactionCreate', function (interaction) {
458 | console.log(`interaction is created -> ${interaction}`);
459 | });
460 | ```
461 |
462 | ## Message Events:
463 |
464 | ### messageCreate
465 |
466 | ##### Emitted whenever a message is created.
467 |
468 | ```js
469 | // PARAMETER TYPE DESCRIPTION
470 | // message Message The created message
471 |
472 | client.on('messageCreate', function (message) {
473 | console.log(`message is created -> ${message}`);
474 | });
475 | ```
476 |
477 | ### messageDelete
478 |
479 | ##### Emitted whenever a message is deleted.
480 |
481 | ```js
482 | // PARAMETER TYPE DESCRIPTION
483 | // message Message The deleted message
484 |
485 | client.on('messageDelete', function (message) {
486 | console.log(`message is deleted -> ${message}`);
487 | });
488 | ```
489 |
490 | ### messageDeleteBulk
491 |
492 | ##### Emitted whenever messages are deleted in bulk.
493 |
494 | ```js
495 | // PARAMETER TYPE DESCRIPTION
496 | // messages Collection The deleted messages, mapped by their ID
497 |
498 | client.on('messageDeleteBulk', function (messages) {
499 | console.log(`messages are deleted -> ${messages}`);
500 | });
501 | ```
502 |
503 | ### messageReactionAdd
504 |
505 | ##### Emitted whenever a reaction is added to a message.
506 |
507 | ```js
508 | // PARAMETER TYPE DESCRIPTION
509 | // messageReaction MessageReaction The reaction object
510 | // user User The user that applied the emoji or reaction emoji
511 |
512 | client.on('messageReactionAdd', function (messageReaction, user) {
513 | console.log(`a reaction is added to a message`);
514 | });
515 | ```
516 |
517 | ### messageReactionRemove
518 |
519 | ##### Emitted whenever a reaction is removed from a message.
520 |
521 | ```js
522 | // PARAMETER TYPE DESCRIPTION
523 | // messageReaction MessageReaction The reaction object
524 | // user User The user that removed the emoji or reaction emoji
525 |
526 | client.on('messageReactionRemove', function (messageReaction, user) {
527 | console.log(`a reaction is removed from a message`);
528 | });
529 | ```
530 |
531 | ### messageReactionRemoveAll
532 |
533 | ##### Emitted whenever all reactions are removed from a message.
534 |
535 | ```js
536 | // PARAMETER TYPE DESCRIPTION
537 | // message Message The message the reactions were removed from
538 |
539 | client.on('messageReactionRemoveAll', function (message) {
540 | console.error(`all reactions are removed from a message`);
541 | });
542 | ```
543 |
544 | ### messageUpdate
545 |
546 | ##### Emitted whenever a message is updated - e.g. embed or content change.
547 |
548 | ```js
549 | // PARAMETER TYPE DESCRIPTION
550 | // oldMessage Message The message before the update
551 | // newMessage Message The message after the update
552 |
553 | client.on('messageUpdate', function (oldMessage, newMessage) {
554 | console.log(`a message is updated`);
555 | });
556 | ```
557 |
558 | ### typingStart
559 |
560 | ##### Emitted whenever a user starts typing in a channel.
561 |
562 | ```js
563 | // PARAMETER TYPE DESCRIPTION
564 | // channel Channel The channel the user started typing in
565 | // user User The user that started typing
566 |
567 | client.on('typingStart', function (channel, user) {
568 | console.log(`${user.tag} has started typing`);
569 | });
570 | ```
571 |
572 | ### typingStop
573 |
574 | ##### Emitted whenever a user stops typing in a channel.
575 |
576 | ```js
577 | // PARAMETER TYPE DESCRIPTION
578 | // channel Channel The channel the user stopped typing in
579 | // user User The user that stopped typing
580 |
581 | client.on('typingStop', function (channel, user) {
582 | console.log(`${user.tag} has stopped typing`);
583 | });
584 | ```
585 |
586 | ## Client Events:
587 |
588 | ### ready
589 |
590 | ##### Emitted when the client becomes ready to start working.
591 |
592 | ```js
593 | client.on('ready', function () {
594 | console.log(`Logged in as ${client.user.tag}!`);
595 | });
596 | ```
597 |
598 | ## Role Events:
599 |
600 | ### roleCreate
601 |
602 | ##### Emitted whenever a role is created.
603 |
604 | ```js
605 | // PARAMETER TYPE DESCRIPTION
606 | // role Role The role that was created
607 |
608 | client.on('roleCreate', function (role) {
609 | console.error(`a role is created`);
610 | });
611 | ```
612 |
613 | ### roleDelete
614 |
615 | ##### Emitted whenever a guild role is deleted.
616 |
617 | ```js
618 | // PARAMETER TYPE DESCRIPTION
619 | // role Role The role that was deleted
620 |
621 | client.on('roleDelete', function (role) {
622 | console.error(`a guild role is deleted`);
623 | });
624 | ```
625 |
626 | ### roleUpdate
627 |
628 | ##### Emitted whenever a guild role is updated.
629 |
630 | ```js
631 | // PARAMETER TYPE DESCRIPTION
632 | // oldRole Role The role before the update
633 | // newRole Role The role after the update
634 |
635 | client.on('roleUpdate', function (oldRole, newRole) {
636 | console.error(`a guild role is updated`);
637 | });
638 | ```
639 |
640 | ## User Events:
641 |
642 | ### userNoteUpdate
643 |
644 | ##### Emitted whenever a note is updated.
645 |
646 | ```js
647 | // PARAMETER TYPE DESCRIPTION
648 | // user User The user the note belongs to
649 | // oldNote String The note content before the update
650 | // newNote String The note content after the update
651 |
652 | client.on('userNoteUpdate', function (user, oldNote, newNote) {
653 | console.log(`a member's note is updated`);
654 | });
655 | ```
656 |
657 | ### userUpdate
658 |
659 | ##### Emitted whenever a user's details (e.g. username) are changed.
660 |
661 | ```js
662 | // PARAMETER TYPE DESCRIPTION
663 | // oldUser User The user before the update
664 | // newUser User The user after the update
665 |
666 | client.on('userUpdate', function (oldUser, newUser) {
667 | console.log(`user's details (e.g. username) are changed`);
668 | });
669 | ```
670 |
671 | ### voiceStateUpdate
672 |
673 | ##### Emitted whenever a user changes voice state - e.g. `joins/leaves a channel, mutes/unmutes`.
674 |
675 | ```js
676 | // PARAMETER TYPE DESCRIPTION
677 | // oldMember GuildMember The member before the voice state update
678 | // newMember GuildMember The member after the voice state update
679 |
680 | client.on('voiceStateUpdate', function (oldMember, newMember) {
681 | console.log(`a user changes voice state`);
682 | });
683 | ```
684 |
685 | ### Thanks for reading!
686 |
687 | Feel free to reach out to me for support.
688 |
689 | ### By: [armful#0001](https://github.com/armfxl)
690 |
691 |
692 |
693 | 
694 |
695 |
696 |
--------------------------------------------------------------------------------
/cheatsheet.js:
--------------------------------------------------------------------------------
1 | // Channel Events:
2 |
3 | // channelCreate
4 |
5 | // Emitted whenever a channel is created.
6 | // PARAMETER TYPE DESCRIPTION
7 | // channel Channel The channel that was created
8 |
9 | client.on('channelCreate', function (channel) {
10 | console.log(`channelCreate: ${channel}`);
11 | });
12 |
13 | // channelDelete
14 |
15 | // Emitted whenever a channel is deleted.
16 | // PARAMETER TYPE DESCRIPTION
17 | // channel Channel The channel that was deleted
18 |
19 | client.on('channelDelete', function (channel) {
20 | console.log(`channelDelete: ${channel}`);
21 | });
22 |
23 | // channelPinsUpdate
24 |
25 | // Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information can be provided easily here.
26 | // PARAMETER TYPE DESCRIPTION
27 | // channel Channel The channel that the pins update occurred in
28 | // time Date The time of the pins update
29 |
30 | client.on('channelPinsUpdate', function (channel, time) {
31 | console.log(`channelPinsUpdate: ${channel}:${time}`);
32 | });
33 |
34 | // channelUpdate
35 |
36 | // Emitted whenever a channel is updated - e.g. name change, topic change.
37 | // PARAMETER TYPE DESCRIPTION
38 | // oldChannel Channel The channel before the update
39 | // newChannel Channel The channel after the update
40 |
41 | client.on('channelUpdate', function (oldChannel, newChannel) {
42 | console.log(`channelUpdate -> a channel is updated - e.g. name change, topic change`);
43 | });
44 |
45 | // Client User Events:
46 |
47 | // clientUserGuildSettingsUpdate
48 |
49 | // Emitted whenever the client user's settings update.
50 | // PARAMETER TYPE DESCRIPTION
51 | // clientUserGuildSettings ClientUserGuildSettings The new client user guild settings
52 |
53 | client.on('clientUserGuildSettingsUpdate', function (clientUserGuildSettings) {
54 | console.log(`clientUserGuildSettingsUpdate -> client user's settings update`);
55 | });
56 |
57 | // clientUserSettingsUpdate
58 |
59 | // Emitted when the client user's settings update.
60 | // PARAMETER TYPE DESCRIPTION
61 | // clientUserSettings ClientUserSettings The new client user settings
62 |
63 | client.on('clientUserSettingsUpdate', function (clientUserSettings) {
64 | console.log(`clientUserSettingsUpdate -> client user's settings update`);
65 | });
66 |
67 | // Debug Events:
68 |
69 | // debug
70 |
71 | // Emitted for general debugging information.
72 | // PARAMETER TYPE DESCRIPTION
73 | // info string The debug information
74 |
75 | client.on('debug', function (info) {
76 | console.log(`debug -> ${info}`);
77 | });
78 |
79 | // Error Events:
80 |
81 | // error
82 |
83 | // Emitted whenever the client's WebSocket encounters a connection error.
84 | // PARAMETER TYPE DESCRIPTION
85 | // error Error The encountered error
86 |
87 | client.on('error', function (error) {
88 | console.error(`client's WebSocket encountered a connection error: ${error}`);
89 | });
90 |
91 | // warn
92 |
93 | // Emitted for general warnings.
94 | // PARAMETER TYPE DESCRIPTION
95 | // info string The warning
96 |
97 | client.on('warn', function (info) {
98 | console.log(`warn: ${info}`);
99 | });
100 |
101 | // WebSocket Events:
102 |
103 | // disconnect
104 |
105 | // Emitted when the client's WebSocket disconnects and will no longer attempt to reconnect.
106 | // PARAMETER TYPE DESCRIPTION
107 | // Event CloseEvent The WebSocket close event
108 |
109 | client.on('disconnect', function (event) {
110 | console.log(`The WebSocket has closed and will no longer attempt to reconnect`);
111 | });
112 |
113 | // reconnecting
114 |
115 | // Emitted whenever the client tries to reconnect to the WebSocket.
116 | client.on('reconnecting', function () {
117 | console.log(`client tries to reconnect to the WebSocket`);
118 | });
119 |
120 | // resume
121 |
122 | // Emitted whenever a WebSocket resumes.
123 | // PARAMETER TYPE DESCRIPTION
124 | // replayed number The number of events that were replayed
125 |
126 | client.on('resume', function (replayed) {
127 | console.log(`whenever a WebSocket resumes, ${replayed} replays`);
128 | });
129 |
130 | // Emoji Events:
131 |
132 | // emojiCreate
133 |
134 | // Emitted whenever a custom emoji is created in a guild.
135 | // PARAMETER TYPE DESCRIPTION
136 | // emoji Emoji The emoji that was created
137 |
138 | client.on('emojiCreate', function (emoji) {
139 | console.log(`a custom emoji is created in a guild`);
140 | });
141 |
142 | // emojiDelete
143 |
144 | // Emitted whenever a custom guild emoji is deleted.
145 | // PARAMETER TYPE DESCRIPTION
146 | // emoji Emoji The emoji that was deleted
147 |
148 | client.on('emojiDelete', function (emoji) {
149 | console.log(`a custom guild emoji is deleted`);
150 | });
151 |
152 | // emojiUpdate
153 |
154 | // Emitted whenever a custom guild emoji is updated.
155 | // PARAMETER TYPE DESCRIPTION
156 | // oldEmoji Emoji The old emoji
157 | // newEmoji Emoji The new emoji
158 |
159 | client.on('emojiUpdate', function (oldEmoji, newEmoji) {
160 | console.log(`a custom guild emoji is updated`);
161 | });
162 |
163 | // Guild Events:
164 |
165 | // guildBanAdd
166 |
167 | // Emitted whenever a member is banned from a guild.
168 | // PARAMETER TYPE DESCRIPTION
169 | // guild Guild The guild that the ban occurred in
170 | // user User The user that was banned
171 |
172 | client.on('guildBanAdd', function (guild, user) {
173 | console.log(`a member is banned from a guild`);
174 | });
175 |
176 | // guildBanRemove
177 |
178 | // Emitted whenever a member is unbanned from a guild.
179 | // PARAMETER TYPE DESCRIPTION
180 | // guild Guild The guild that the unban occurred in
181 | // user User The user that was unbanned
182 |
183 | client.on('guildBanRemove', function (guild, user) {
184 | console.log(`a member is unbanned from a guild`);
185 | });
186 |
187 | // guildCreate
188 |
189 | // Emitted whenever the client joins a guild.
190 | // PARAMETER TYPE DESCRIPTION
191 | // guild Guild The created guild
192 |
193 | client.on('guildCreate', function (guild) {
194 | console.log(`the client joins a guild`);
195 | });
196 |
197 | // guildDelete
198 |
199 | // Emitted whenever a guild is deleted/left.
200 | // PARAMETER TYPE DESCRIPTION
201 | // guild Guild The guild that was deleted
202 |
203 | client.on('guildDelete', function (guild) {
204 | console.log(`the client deleted/left a guild`);
205 | });
206 |
207 | // guildUnavailable
208 |
209 | // Emitted whenever a guild becomes unavailable, likely due to a server outage.
210 | // PARAMETER TYPE DESCRIPTION
211 | // guild Guild The guild that has become unavailable
212 |
213 | client.on('guildUnavailable', function (guild) {
214 | console.error(`a guild becomes unavailable, likely due to a server outage: ${guild}`);
215 | });
216 |
217 | // guildUpdate
218 |
219 | // Emitted whenever a guild is updated - e.g. name change.
220 | // PARAMETER TYPE DESCRIPTION
221 | // oldGuild Guild The guild before the update
222 | // newGuild Guild The guild after the update
223 |
224 | client.on('guildUpdate', function (oldGuild, newGuild) {
225 | console.error(`a guild is updated`);
226 | });
227 |
228 | // Guild Member Events:
229 |
230 | // guildMemberAdd
231 |
232 | // Emitted whenever a user joins a guild.
233 | // PARAMETER TYPE DESCRIPTION
234 | // member GuildMember The member that has joined a guild
235 |
236 | client.on('guildMemberAdd', function (member) {
237 | console.log(`a user joins a guild: ${member.tag}`);
238 | });
239 |
240 | // guildMemberAvailable
241 |
242 | // Emitted whenever a member becomes available in a large guild.
243 | // PARAMETER TYPE DESCRIPTION
244 | // member GuildMember The member that became available
245 |
246 | client.on('guildMemberAvailable', function (member) {
247 | console.log(`member becomes available in a large guild: ${member.tag}`);
248 | });
249 |
250 | // guildMemberRemove
251 |
252 | // Emitted whenever a member leaves a guild, or is kicked.
253 | // PARAMETER TYPE DESCRIPTION
254 | // member GuildMember The member that has left/been kicked from the guild
255 |
256 | client.on('guildMemberRemove', function (member) {
257 | console.log(`a member leaves a guild, or is kicked: ${member.tag}`);
258 | });
259 |
260 | // guildMembersChunk
261 |
262 | // Emitted whenever a chunk of guild members is received (all members come from the same guild).
263 | // PARAMETER TYPE DESCRIPTION
264 | // members Array The members in the chunk
265 | // guild Guild The guild related to the member chunk
266 |
267 | client.on('guildMembersChunk', function (members, guild) {
268 | console.error(`a chunk of guild members is received`);
269 | });
270 |
271 | // guildMemberUpdate
272 |
273 | // Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
274 | // PARAMETER TYPE DESCRIPTION
275 | // oldMember GuildMember The member before the update
276 | // newMember GuildMember The member after the update
277 |
278 | client.on('guildMemberUpdate', function (oldMember, newMember) {
279 | console.error(`a guild member changes - i.e. new role, removed role, nickname.`);
280 | });
281 |
282 | // presenceUpdate
283 |
284 | // Emitted whenever a guild member's presence changes, or they change one of their details.
285 | // PARAMETER TYPE DESCRIPTION
286 | // oldMember GuildMember The member before the presence update
287 | // newMember GuildMember The member after the presence update
288 |
289 | client.on('presenceUpdate', function (oldMember, newMember) {
290 | console.log(`a guild member's presence changes`);
291 | });
292 |
293 | // Interaction Event:
294 |
295 | // interactionCreate
296 |
297 | // Emitted whenever a message is created.
298 | // PARAMETER TYPE DESCRIPTION
299 | // interaction Interaction The created interaction
300 |
301 | client.on('interactionCreate', function (interaction) {
302 | console.log(`interaction is created -> ${interaction}`);
303 | });
304 |
305 | // Message Events:
306 |
307 | // messageCreate
308 |
309 | // Emitted whenever a message is created.
310 | // PARAMETER TYPE DESCRIPTION
311 | // message Message The created message
312 |
313 | client.on('messageCreate', function (message) {
314 | console.log(`message is created -> ${message}`);
315 | });
316 |
317 | // messageDelete
318 |
319 | // Emitted whenever a message is deleted.
320 | // PARAMETER TYPE DESCRIPTION
321 | // message Message The deleted message
322 |
323 | client.on('messageDelete', function (message) {
324 | console.log(`message is deleted -> ${message}`);
325 | });
326 |
327 | // messageDeleteBulk
328 |
329 | // Emitted whenever messages are deleted in bulk.
330 | // PARAMETER TYPE DESCRIPTION
331 | // messages Collection The deleted messages, mapped by their ID
332 |
333 | client.on('messageDeleteBulk', function (messages) {
334 | console.log(`messages are deleted -> ${messages}`);
335 | });
336 |
337 | // messageReactionAdd
338 |
339 | // Emitted whenever a reaction is added to a message.
340 | // PARAMETER TYPE DESCRIPTION
341 | // messageReaction MessageReaction The reaction object
342 | // user User The user that applied the emoji or reaction emoji
343 |
344 | client.on('messageReactionAdd', function (messageReaction, user) {
345 | console.log(`a reaction is added to a message`);
346 | });
347 |
348 | // messageReactionRemove
349 |
350 | // Emitted whenever a reaction is removed from a message.
351 | // PARAMETER TYPE DESCRIPTION
352 | // messageReaction MessageReaction The reaction object
353 | // user User The user that removed the emoji or reaction emoji
354 |
355 | client.on('messageReactionRemove', function (messageReaction, user) {
356 | console.log(`a reaction is removed from a message`);
357 | });
358 |
359 | // messageReactionRemoveAll
360 |
361 | // Emitted whenever all reactions are removed from a message.
362 | // PARAMETER TYPE DESCRIPTION
363 | // message Message The message the reactions were removed from
364 |
365 | client.on('messageReactionRemoveAll', function (message) {
366 | console.error(`all reactions are removed from a message`);
367 | });
368 |
369 | // messageUpdate
370 |
371 | // Emitted whenever a message is updated - e.g. embed or content change.
372 | // PARAMETER TYPE DESCRIPTION
373 | // oldMessage Message The message before the update
374 | // newMessage Message The message after the update
375 |
376 | client.on('messageUpdate', function (oldMessage, newMessage) {
377 | console.log(`a message is updated`);
378 | });
379 |
380 | // typingStart
381 |
382 | // Emitted whenever a user starts typing in a channel.
383 | // PARAMETER TYPE DESCRIPTION
384 | // channel Channel The channel the user started typing in
385 | // user User The user that started typing
386 |
387 | client.on('typingStart', function (channel, user) {
388 | console.log(`${user.tag} has started typing`);
389 | });
390 |
391 | // typingStop
392 |
393 | // Emitted whenever a user stops typing in a channel.
394 | // PARAMETER TYPE DESCRIPTION
395 | // channel Channel The channel the user stopped typing in
396 | // user User The user that stopped typing
397 |
398 | client.on('typingStop', function (channel, user) {
399 | console.log(`${user.tag} has stopped typing`);
400 | });
401 |
402 | // Client Events:
403 |
404 | // ready
405 |
406 | // Emitted when the client becomes ready to start working.
407 | client.on('ready', function () {
408 | console.log(`Logged in as ${client.user.tag}!`);
409 | });
410 |
411 | // Role Events:
412 |
413 | // roleCreate
414 |
415 | // Emitted whenever a role is created.
416 | // PARAMETER TYPE DESCRIPTION
417 | // role Role The role that was created
418 |
419 | client.on('roleCreate', function (role) {
420 | console.error(`a role is created`);
421 | });
422 |
423 | // roleDelete
424 |
425 | // Emitted whenever a guild role is deleted.
426 | // PARAMETER TYPE DESCRIPTION
427 | // role Role The role that was deleted
428 |
429 | client.on('roleDelete', function (role) {
430 | console.error(`a guild role is deleted`);
431 | });
432 |
433 | // roleUpdate
434 |
435 | // Emitted whenever a guild role is updated.
436 | // PARAMETER TYPE DESCRIPTION
437 | // oldRole Role The role before the update
438 | // newRole Role The role after the update
439 |
440 | client.on('roleUpdate', function (oldRole, newRole) {
441 | console.error(`a guild role is updated`);
442 | });
443 |
444 | // User Events:
445 |
446 | // userNoteUpdate
447 |
448 | // Emitted whenever a note is updated.
449 | // PARAMETER TYPE DESCRIPTION
450 | // user User The user the note belongs to
451 | // oldNote String The note content before the update
452 | // newNote String The note content after the update
453 |
454 | client.on('userNoteUpdate', function (user, oldNote, newNote) {
455 | console.log(`a member's note is updated`);
456 | });
457 |
458 | // userUpdate
459 |
460 | // Emitted whenever a user's details (e.g. username) are changed.
461 | // PARAMETER TYPE DESCRIPTION
462 | // oldUser User The user before the update
463 | // newUser User The user after the update
464 |
465 | client.on('userUpdate', function (oldUser, newUser) {
466 | console.log(`user's details (e.g. username) are changed`);
467 | });
468 |
469 | // voiceStateUpdate
470 |
471 | // Emitted whenever a user changes voice state - e.g. joins/leaves a channel, mutes/unmutes.
472 | // PARAMETER TYPE DESCRIPTION
473 | // oldMember GuildMember The member before the voice state update
474 | // newMember GuildMember The member after the voice state update
475 |
476 | client.on('voiceStateUpdate', function (oldMember, newMember) {
477 | console.log(`a user changes voice state`);
478 | });
479 |
--------------------------------------------------------------------------------