class ClientUser

extends

export class ClientUser extends User

Represents the logged in client's Discord user.

accentColor : number | null | undefined

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

Inherited from: User

avatar : string | null

The user avatar's hash

Inherited from: User

deprecated
avatarDecoration : string | null

Use avatarDecorationData instead

Deprecated

The user avatar decoration's hash

Inherited from: User

avatarDecorationData : AvatarDecorationData | null

The user avatar decoration's data

Inherited from: User

The user banner's hash The user must be force fetched for this property to be present or be updated

Inherited from: User

bot : boolean

Whether or not the user is a bot

Inherited from: User

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time the user was created at

Inherited from: User

readonly
createdTimestamp : number

The timestamp the user was created at

Inherited from: User

readonly
defaultAvatarURL : string

A link to the user's default avatar

Inherited from: User

discriminator : string

The discriminator of this user '0', or a 4-digit stringified number if they're using the legacy username system

Inherited from: User

readonly
displayName : string

The global name of this user, or their username if they don't have one

Inherited from: User

readonly
dmChannel : DMChannel | null

The DM between the client's user and this user

Inherited from: User

flags : Readonly<UserFlagsBitField> | null

The flags for this user

Inherited from: User

globalName : string | null

The global name of this user

Inherited from: User

readonly
hexAccentColor : HexColorString | null | undefined

The hexadecimal version of the user accent color, with a leading hash The user must be force fetched for this property to be present

Inherited from: User

mfaEnabled : boolean

If the bot's Owner has MFA enabled on their account

readonly
partial : false

Whether this User is a partial

Inherited from: User

readonly
presence : ClientPresence

Represents the client user's presence

system : boolean

Whether the user is an Official Discord System user (part of the urgent message system)

Inherited from: User

readonly
tag : string

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

Inherited from: User

username : string

The username of the user

Inherited from: User

verified : boolean

Whether or not this account has been verified

avatarDecorationURL(
options?: BaseImageURLOptions = {}
) : string | null

A link to the user's avatar decoration.

Inherited from: User

avatarURL(
options?: ImageURLOptions = {}
) : string | null

A link to the user's avatar.

Inherited from: User

bannerURL(
options?: ImageURLOptions = {}
) : string | null | undefined

A link to the user's banner. See banner for more info

Inherited from: User

createDM(
force?: boolean = false
) : Promise<DMChannel>

Creates a DM channel between the client and the user.

Inherited from: User

deleteDM() : Promise<DMChannel>

Deletes a DM channel (if one exists) between the client and the user. Resolves with the channel if successful.

Inherited from: User

displayAvatarURL(
options?: 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

edit(
options: ClientUserEditOptions
) : Promise<this>

Edits the logged in client.

equals(
user: User
) : boolean

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

fetch(
force?: boolean = true
) : Promise<User>

Fetches this user.

Inherited from: User

deprecated
fetchFlags(
force?: boolean = false
) : Promise<UserFlagsBitField>

This method is deprecated and will be removed in the next major version. Flags may still be retrieved via fetch.

Deprecated

Fetches this user's flags.

Inherited from: User

send(
options: string | MessagePayload | MessageCreateOptions
) : Promise<Message>

Sends a message to this user.

Examples:

// Send a direct message
user.send('Hello!')
  .then(message => console.log(`Sent message: ${message.content} to ${user.tag}`))
  .catch(console.error);

Inherited from: User

Overload 1

Overload 2

setActivity(
options?: ActivityOptions
) : ClientPresence

Sets the activity the client user is playing.

Examples:

// Set the client user's activity
client.user.setActivity('discord.js', { type: ActivityType.Watching });

setAFK(
afk?: boolean = true
shardId?: number | readonly number[]
) : ClientPresence

Sets/removes the AFK flag for the client user.

setAvatar(
avatar: BufferResolvable | Base64Resolvable | null
) : Promise<this>

Sets the avatar of the logged in client.

Examples:

// Set avatar
client.user.setAvatar('./avatar.png')
  .then(user => console.log(`New avatar set!`))
  .catch(console.error);

setBanner(
banner: BufferResolvable | Base64Resolvable | null
) : Promise<this>

Sets the banner of the logged in client.

Examples:

// Set banner
client.user.setBanner('./banner.png')
  .then(user => console.log(`New banner set!`))
  .catch(console.error);

setPresence(
data: PresenceData
) : ClientPresence

Sets the full presence of the client user.

Examples:

// Set the client user's presence
client.user.setPresence({ activities: [{ name: 'with discord.js' }], status: 'idle' });

setStatus(
status: PresenceStatusData
shardId?: number | readonly number[]
) : ClientPresence

Sets the status of the client user.

Examples:

// Set the client user's status
client.user.setStatus('idle');

setUsername(
username: string
) : Promise<this>

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!

Examples:

// Set username
client.user.setUsername('discordjs')
  .then(user => console.log(`My new username is ${user.username}`))
  .catch(console.error);

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

toString() : UserMention

When concatenated with a string, this automatically returns the user's mention instead of the User object.

Examples:

// Logs: Hello from <@123456789012345678>!
console.log(`Hello from ${user}!`);

Inherited from: User

valueOf() : string

Inherited from: Base

class ClientUser

extends

Table of contents

Properties

Methods

Properties

accentColor : number | null | undefined

avatar : string | null

deprecatedavatarDecoration : string | null

avatarDecorationData : AvatarDecorationData | null

banner : string | null | undefined

bot : boolean

readonlyclient : Client<true>

readonlycreatedAt : Date

readonlycreatedTimestamp : number

readonlydefaultAvatarURL : string

discriminator : string

readonlydisplayName : string

readonlydmChannel : DMChannel | null

flags : Readonly<UserFlagsBitField> | null

globalName : string | null

readonlyhexAccentColor : HexColorString | null | undefined

id : Snowflake

mfaEnabled : boolean

readonlypartial : false

readonlypresence : ClientPresence

system : boolean

readonlytag : string

username : string

verified : boolean

Methods

avatarDecorationURL(options?: BaseImageURLOptions = {}) : string | null

avatarURL(options?: ImageURLOptions = {}) : string | null

bannerURL(options?: ImageURLOptions = {}) : string | null | undefined

createDM(force?: boolean = false) : Promise<DMChannel>

deleteDM() : Promise<DMChannel>

displayAvatarURL(options?: ImageURLOptions = {}) : string

edit(options: ClientUserEditOptions) : Promise<this>

equals(user: User) : boolean

fetch(force?: boolean = true) : Promise<User>

deprecated fetchFlags(force?: boolean = false) : Promise<UserFlagsBitField>

send(options: string | MessagePayload | MessageCreateOptions) : Promise<Message>

setActivity(options?: ActivityOptions) : ClientPresence

setAFK(afk?: boolean = trueshardId?: number | readonly number[]) : ClientPresence

setAvatar(avatar: BufferResolvable | Base64Resolvable | null) : Promise<this>

setBanner(banner: BufferResolvable | Base64Resolvable | null) : Promise<this>

setPresence(data: PresenceData) : ClientPresence

setStatus(status: PresenceStatusDatashardId?: number | readonly number[]) : ClientPresence

setUsername(username: string) : Promise<this>

toJSON(...props: Record<string, boolean | string>[]) : unknown

toString() : UserMention

valueOf() : string

deprecated
avatarDecoration : string | null

readonly
client : Client<true>

readonly
createdAt : Date

readonly
createdTimestamp : number

readonly
defaultAvatarURL : string

readonly
displayName : string

readonly
dmChannel : DMChannel | null

readonly
hexAccentColor : HexColorString | null | undefined

readonly
partial : false

readonly
presence : ClientPresence

readonly
tag : string

avatarDecorationURL(
options?: BaseImageURLOptions = {}
) : string | null

avatarURL(
options?: ImageURLOptions = {}
) : string | null

bannerURL(
options?: ImageURLOptions = {}
) : string | null | undefined

createDM(
force?: boolean = false
) : Promise<DMChannel>

displayAvatarURL(
options?: ImageURLOptions = {}
) : string

edit(
options: ClientUserEditOptions
) : Promise<this>

equals(
user: User
) : boolean

fetch(
force?: boolean = true
) : Promise<User>

deprecated
fetchFlags(
force?: boolean = false
) : Promise<UserFlagsBitField>

send(
options: string | MessagePayload | MessageCreateOptions
) : Promise<Message>

setActivity(
options?: ActivityOptions
) : ClientPresence

setAFK(
afk?: boolean = true
shardId?: number | readonly number[]
) : ClientPresence

setAvatar(
avatar: BufferResolvable | Base64Resolvable | null
) : Promise<this>

setBanner(
banner: BufferResolvable | Base64Resolvable | null
) : Promise<this>

setPresence(
data: PresenceData
) : ClientPresence

setStatus(
status: PresenceStatusData
shardId?: number | readonly number[]
) : ClientPresence

setUsername(
username: string
) : Promise<this>

toJSON(
...props: Record<string, boolean | string>[]
) : unknown