-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
cheatsheet.js
478 lines (336 loc) · 14.2 KB
/
cheatsheet.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// Channel Events:
// channelCreate
// Emitted whenever a channel is created.
// PARAMETER TYPE DESCRIPTION
// channel Channel The channel that was created
client.on('channelCreate', function (channel) {
console.log(`channelCreate: ${channel}`);
});
// channelDelete
// Emitted whenever a channel is deleted.
// PARAMETER TYPE DESCRIPTION
// channel Channel The channel that was deleted
client.on('channelDelete', function (channel) {
console.log(`channelDelete: ${channel}`);
});
// channelPinsUpdate
// 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.
// PARAMETER TYPE DESCRIPTION
// channel Channel The channel that the pins update occurred in
// time Date The time of the pins update
client.on('channelPinsUpdate', function (channel, time) {
console.log(`channelPinsUpdate: ${channel}:${time}`);
});
// channelUpdate
// Emitted whenever a channel is updated - e.g. name change, topic change.
// PARAMETER TYPE DESCRIPTION
// oldChannel Channel The channel before the update
// newChannel Channel The channel after the update
client.on('channelUpdate', function (oldChannel, newChannel) {
console.log(`channelUpdate -> a channel is updated - e.g. name change, topic change`);
});
// Client User Events:
// clientUserGuildSettingsUpdate
// Emitted whenever the client user's settings update.
// PARAMETER TYPE DESCRIPTION
// clientUserGuildSettings ClientUserGuildSettings The new client user guild settings
client.on('clientUserGuildSettingsUpdate', function (clientUserGuildSettings) {
console.log(`clientUserGuildSettingsUpdate -> client user's settings update`);
});
// clientUserSettingsUpdate
// Emitted when the client user's settings update.
// PARAMETER TYPE DESCRIPTION
// clientUserSettings ClientUserSettings The new client user settings
client.on('clientUserSettingsUpdate', function (clientUserSettings) {
console.log(`clientUserSettingsUpdate -> client user's settings update`);
});
// Debug Events:
// debug
// Emitted for general debugging information.
// PARAMETER TYPE DESCRIPTION
// info string The debug information
client.on('debug', function (info) {
console.log(`debug -> ${info}`);
});
// Error Events:
// error
// Emitted whenever the client's WebSocket encounters a connection error.
// PARAMETER TYPE DESCRIPTION
// error Error The encountered error
client.on('error', function (error) {
console.error(`client's WebSocket encountered a connection error: ${error}`);
});
// warn
// Emitted for general warnings.
// PARAMETER TYPE DESCRIPTION
// info string The warning
client.on('warn', function (info) {
console.log(`warn: ${info}`);
});
// WebSocket Events:
// disconnect
// Emitted when the client's WebSocket disconnects and will no longer attempt to reconnect.
// PARAMETER TYPE DESCRIPTION
// Event CloseEvent The WebSocket close event
client.on('disconnect', function (event) {
console.log(`The WebSocket has closed and will no longer attempt to reconnect`);
});
// reconnecting
// Emitted whenever the client tries to reconnect to the WebSocket.
client.on('reconnecting', function () {
console.log(`client tries to reconnect to the WebSocket`);
});
// resume
// Emitted whenever a WebSocket resumes.
// PARAMETER TYPE DESCRIPTION
// replayed number The number of events that were replayed
client.on('resume', function (replayed) {
console.log(`whenever a WebSocket resumes, ${replayed} replays`);
});
// Emoji Events:
// emojiCreate
// Emitted whenever a custom emoji is created in a guild.
// PARAMETER TYPE DESCRIPTION
// emoji Emoji The emoji that was created
client.on('emojiCreate', function (emoji) {
console.log(`a custom emoji is created in a guild`);
});
// emojiDelete
// Emitted whenever a custom guild emoji is deleted.
// PARAMETER TYPE DESCRIPTION
// emoji Emoji The emoji that was deleted
client.on('emojiDelete', function (emoji) {
console.log(`a custom guild emoji is deleted`);
});
// emojiUpdate
// Emitted whenever a custom guild emoji is updated.
// PARAMETER TYPE DESCRIPTION
// oldEmoji Emoji The old emoji
// newEmoji Emoji The new emoji
client.on('emojiUpdate', function (oldEmoji, newEmoji) {
console.log(`a custom guild emoji is updated`);
});
// Guild Events:
// guildBanAdd
// Emitted whenever a member is banned from a guild.
// PARAMETER TYPE DESCRIPTION
// guild Guild The guild that the ban occurred in
// user User The user that was banned
client.on('guildBanAdd', function (guild, user) {
console.log(`a member is banned from a guild`);
});
// guildBanRemove
// Emitted whenever a member is unbanned from a guild.
// PARAMETER TYPE DESCRIPTION
// guild Guild The guild that the unban occurred in
// user User The user that was unbanned
client.on('guildBanRemove', function (guild, user) {
console.log(`a member is unbanned from a guild`);
});
// guildCreate
// Emitted whenever the client joins a guild.
// PARAMETER TYPE DESCRIPTION
// guild Guild The created guild
client.on('guildCreate', function (guild) {
console.log(`the client joins a guild`);
});
// guildDelete
// Emitted whenever a guild is deleted/left.
// PARAMETER TYPE DESCRIPTION
// guild Guild The guild that was deleted
client.on('guildDelete', function (guild) {
console.log(`the client deleted/left a guild`);
});
// guildUnavailable
// Emitted whenever a guild becomes unavailable, likely due to a server outage.
// PARAMETER TYPE DESCRIPTION
// guild Guild The guild that has become unavailable
client.on('guildUnavailable', function (guild) {
console.error(`a guild becomes unavailable, likely due to a server outage: ${guild}`);
});
// guildUpdate
// Emitted whenever a guild is updated - e.g. name change.
// PARAMETER TYPE DESCRIPTION
// oldGuild Guild The guild before the update
// newGuild Guild The guild after the update
client.on('guildUpdate', function (oldGuild, newGuild) {
console.error(`a guild is updated`);
});
// Guild Member Events:
// guildMemberAdd
// Emitted whenever a user joins a guild.
// PARAMETER TYPE DESCRIPTION
// member GuildMember The member that has joined a guild
client.on('guildMemberAdd', function (member) {
console.log(`a user joins a guild: ${member.tag}`);
});
// guildMemberAvailable
// Emitted whenever a member becomes available in a large guild.
// PARAMETER TYPE DESCRIPTION
// member GuildMember The member that became available
client.on('guildMemberAvailable', function (member) {
console.log(`member becomes available in a large guild: ${member.tag}`);
});
// guildMemberRemove
// Emitted whenever a member leaves a guild, or is kicked.
// PARAMETER TYPE DESCRIPTION
// member GuildMember The member that has left/been kicked from the guild
client.on('guildMemberRemove', function (member) {
console.log(`a member leaves a guild, or is kicked: ${member.tag}`);
});
// guildMembersChunk
// Emitted whenever a chunk of guild members is received (all members come from the same guild).
// PARAMETER TYPE DESCRIPTION
// members Array<GuildMember> The members in the chunk
// guild Guild The guild related to the member chunk
client.on('guildMembersChunk', function (members, guild) {
console.error(`a chunk of guild members is received`);
});
// guildMemberUpdate
// Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
// PARAMETER TYPE DESCRIPTION
// oldMember GuildMember The member before the update
// newMember GuildMember The member after the update
client.on('guildMemberUpdate', function (oldMember, newMember) {
console.error(`a guild member changes - i.e. new role, removed role, nickname.`);
});
// presenceUpdate
// Emitted whenever a guild member's presence changes, or they change one of their details.
// PARAMETER TYPE DESCRIPTION
// oldMember GuildMember The member before the presence update
// newMember GuildMember The member after the presence update
client.on('presenceUpdate', function (oldMember, newMember) {
console.log(`a guild member's presence changes`);
});
// Interaction Event:
// interactionCreate
// Emitted whenever a message is created.
// PARAMETER TYPE DESCRIPTION
// interaction Interaction The created interaction
client.on('interactionCreate', function (interaction) {
console.log(`interaction is created -> ${interaction}`);
});
// Message Events:
// messageCreate
// Emitted whenever a message is created.
// PARAMETER TYPE DESCRIPTION
// message Message The created message
client.on('messageCreate', function (message) {
console.log(`message is created -> ${message}`);
});
// messageDelete
// Emitted whenever a message is deleted.
// PARAMETER TYPE DESCRIPTION
// message Message The deleted message
client.on('messageDelete', function (message) {
console.log(`message is deleted -> ${message}`);
});
// messageDeleteBulk
// Emitted whenever messages are deleted in bulk.
// PARAMETER TYPE DESCRIPTION
// messages Collection<Snowflake, Message> The deleted messages, mapped by their ID
client.on('messageDeleteBulk', function (messages) {
console.log(`messages are deleted -> ${messages}`);
});
// messageReactionAdd
// Emitted whenever a reaction is added to a message.
// PARAMETER TYPE DESCRIPTION
// messageReaction MessageReaction The reaction object
// user User The user that applied the emoji or reaction emoji
client.on('messageReactionAdd', function (messageReaction, user) {
console.log(`a reaction is added to a message`);
});
// messageReactionRemove
// Emitted whenever a reaction is removed from a message.
// PARAMETER TYPE DESCRIPTION
// messageReaction MessageReaction The reaction object
// user User The user that removed the emoji or reaction emoji
client.on('messageReactionRemove', function (messageReaction, user) {
console.log(`a reaction is removed from a message`);
});
// messageReactionRemoveAll
// Emitted whenever all reactions are removed from a message.
// PARAMETER TYPE DESCRIPTION
// message Message The message the reactions were removed from
client.on('messageReactionRemoveAll', function (message) {
console.error(`all reactions are removed from a message`);
});
// messageUpdate
// Emitted whenever a message is updated - e.g. embed or content change.
// PARAMETER TYPE DESCRIPTION
// oldMessage Message The message before the update
// newMessage Message The message after the update
client.on('messageUpdate', function (oldMessage, newMessage) {
console.log(`a message is updated`);
});
// typingStart
// Emitted whenever a user starts typing in a channel.
// PARAMETER TYPE DESCRIPTION
// channel Channel The channel the user started typing in
// user User The user that started typing
client.on('typingStart', function (channel, user) {
console.log(`${user.tag} has started typing`);
});
// typingStop
// Emitted whenever a user stops typing in a channel.
// PARAMETER TYPE DESCRIPTION
// channel Channel The channel the user stopped typing in
// user User The user that stopped typing
client.on('typingStop', function (channel, user) {
console.log(`${user.tag} has stopped typing`);
});
// Client Events:
// ready
// Emitted when the client becomes ready to start working.
client.on('ready', function () {
console.log(`Logged in as ${client.user.tag}!`);
});
// Role Events:
// roleCreate
// Emitted whenever a role is created.
// PARAMETER TYPE DESCRIPTION
// role Role The role that was created
client.on('roleCreate', function (role) {
console.error(`a role is created`);
});
// roleDelete
// Emitted whenever a guild role is deleted.
// PARAMETER TYPE DESCRIPTION
// role Role The role that was deleted
client.on('roleDelete', function (role) {
console.error(`a guild role is deleted`);
});
// roleUpdate
// Emitted whenever a guild role is updated.
// PARAMETER TYPE DESCRIPTION
// oldRole Role The role before the update
// newRole Role The role after the update
client.on('roleUpdate', function (oldRole, newRole) {
console.error(`a guild role is updated`);
});
// User Events:
// userNoteUpdate
// Emitted whenever a note is updated.
// PARAMETER TYPE DESCRIPTION
// user User The user the note belongs to
// oldNote String The note content before the update
// newNote String The note content after the update
client.on('userNoteUpdate', function (user, oldNote, newNote) {
console.log(`a member's note is updated`);
});
// userUpdate
// Emitted whenever a user's details (e.g. username) are changed.
// PARAMETER TYPE DESCRIPTION
// oldUser User The user before the update
// newUser User The user after the update
client.on('userUpdate', function (oldUser, newUser) {
console.log(`user's details (e.g. username) are changed`);
});
// voiceStateUpdate
// Emitted whenever a user changes voice state - e.g. joins/leaves a channel, mutes/unmutes.
// PARAMETER TYPE DESCRIPTION
// oldMember GuildMember The member before the voice state update
// newMember GuildMember The member after the voice state update
client.on('voiceStateUpdate', function (oldMember, newMember) {
console.log(`a user changes voice state`);
});