class ClientUser
extends
Userexport class ClientUser extends User
Represents the logged in client's Discord user.
optionalnumber accentColor? :
The base 10 accent color of the user's banner The user must be force fetched for this property to be present or be updated
optionalstring avatar? :
The user avatar's hash
optionalstring avatarDecoration? :
The user avatar decoration's hash
optionalstring banner? :
The user banner's hash The user must be force fetched for this property to be present or be updated
optionalboolean bot? :
Whether or not the user is a bot
readonlyClient client :
The client that instantiated this
readonlyDate createdAt :
The time the user was created at
readonlynumber createdTimestamp :
The timestamp the user was created at
readonlystring defaultAvatarURL :
A link to the user's default avatar
optionalstring discriminator? :
The discriminator of this user '0'
, or a 4-digit stringified number if they're using the legacy username system
readonlyoptionalstring displayName? :
The global name of this user, or their username if they don't have one
readonlyoptionalDMChannel dmChannel? :
The DM between the client's user and this user
optionalUserFlagsBitField flags? :
The flags for this user
optionalstring globalName? :
The global name of this user
readonlyoptionalstring hexAccentColor? :
The hexadecimal version of the user accent color, with a leading hash The user must be force fetched for this property to be present
Snowflake id :
The user's id
readonlyboolean partial :
Whether this User is a partial
readonlyClientPresence presence :
Represents the client user's presence
optionalboolean system? :
Whether the user is an Official Discord System user (part of the urgent message system)
readonlyoptionalstring tag? :
The tag of this user This user's username, or their legacy tag (e.g. hydrabolt#0001
) if they're using the legacy username system
optionalstring username? :
The username of the user
boolean verified :
Whether or not this account has been verified
avatarDecorationURLoptions?: BaseImageURLOptions) : string | null (
A link to the user's avatar decoration.
Inherited from: User
avatarURLoptions?: ImageURLOptions) : string | null (
A link to the user's avatar.
Inherited from: User
bannerURLoptions?: ImageURLOptions) : string | null | undefined (
A link to the user's banner. See banner for more info
Inherited from: User
Creates a DM channel between the client and the user.
Inherited from: User
Deletes a DM channel (if one exists) between the client and the user. Resolves with the channel if successful.
Inherited from: User
displayAvatarURLoptions?: ImageURLOptions) : string (
A link to the user's avatar if they have one. Otherwise a link to their default avatar will be returned.
Inherited from: User
editoptions: ClientUserEditOptions) : Promise<this> (
Edits the logged in client.
Checks if the user is equal to another. It compares id, username, discriminator, avatar, banner, accent color, and bot flags. It is recommended to compare equality by using user.id === user2.id
unless you want to compare all properties.
Inherited from: User
fetchFlagsforce?: boolean) : Promise<UserFlagsBitField> (
Fetches this user's flags.
Inherited from: User
sendoptions: string | MessagePayload | MessageCreateOptions) : Promise<Message> (
Sends a message to this user.
// Send a direct message
user.send('Hello!')
.then(message => console.log(`Sent message: ${message.content} to ${user.tag}`))
.catch(console.error);
Inherited from: User
setActivityoptions?: ActivityOptions) : ClientPresence (
Sets the activity the client user is playing.
// Set the client user's activity
client.user.setActivity('discord.js', { type: ActivityType.Watching });
setAFK) : ClientPresence (
Sets/removes the AFK flag for the client user.
setAvataravatar: BufferResolvable | Base64Resolvable | null) : Promise<this> (
Sets the avatar of the logged in client.
// Set avatar
client.user.setAvatar('./avatar.png')
.then(user => console.log(`New avatar set!`))
.catch(console.error);
setPresencedata: PresenceData) : ClientPresence (
Sets the full presence of the client user.
// Set the client user's presence
client.user.setPresence({ activities: [{ name: 'with discord.js' }], status: 'idle' });
setStatusstatus: PresenceStatusData) : ClientPresence (
Sets the status of the client user.
// Set the client user's status
client.user.setStatus('idle');
Sets the username of the logged in client. Changing usernames in Discord is heavily rate limited, with only 2 requests every hour. Use this sparingly!
// Set username
client.user.setUsername('discordjs')
.then(user => console.log(`My new username is ${user.username}`))
.catch(console.error);
toStringUserMention () :
When concatenated with a string, this automatically returns the user's mention instead of the User object.
// Logs: Hello from <@123456789012345678>!
console.log(`Hello from ${user}!`);
Inherited from: User