diff --git a/src/client/actions/UserUpdate.js b/src/client/actions/UserUpdate.js index 60adc174..b9c09748 100644 --- a/src/client/actions/UserUpdate.js +++ b/src/client/actions/UserUpdate.js @@ -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,