docs: add missing docstring for Client#userUpdate (#2930)

* docs: add missing docstring for Client#userUpdate

* docs: indentn't

* docs: indentn't 2
This commit is contained in:
Souji
2018-11-05 16:46:47 +00:00
committed by SpaceEEC
parent 7796cb5d05
commit 905f1c3262

View File

@@ -9,6 +9,12 @@ class UserUpdateAction extends Action {
const oldUser = newUser._update(data.user);
if (!oldUser.equals(newUser)) {
/**
* Emitted whenever a user's details (e.g. username) are changed.
* @event Client#userUpdate
* @param {User} oldUser The user before the update
* @param {User} newUser The user after the update
*/
client.emit(Events.USER_UPDATE, oldUser, newUser);
return {
old: oldUser,