User
Defined in: package/src/classes/User.ts:11
Class representing a Discord user
https://docs.discord.com/developers/resources/user#user-object
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new User(
client,data):User
Defined in: package/src/classes/User.ts:48
Instantiate a new user
Parameters
Section titled “Parameters”client
Section titled “client”Associated client
APIUser
Discord API user data
Returns
Section titled “Returns”User
User object
Properties
Section titled “Properties”accentColor?
Section titled “accentColor?”
optionalaccentColor:number
Defined in: package/src/classes/User.ts:13
User banner color as an integer color, if set
accentColorHex
Section titled “accentColorHex”accentColorHex:
string|null
Defined in: package/src/classes/User.ts:16
Accent color as a hex color string, or null
bot:
boolean=false
Defined in: package/src/classes/User.ts:19
Whether this user is a Discord bot
client
Section titled “client”client:
Client
Defined in: package/src/classes/User.ts:22
The client associated with this user
discriminator
Section titled “discriminator”discriminator:
string="0"
Defined in: package/src/classes/User.ts:25
Legacy discriminator, defaults to “0” if no discriminator
displayName?
Section titled “displayName?”
optionaldisplayName:string
Defined in: package/src/classes/User.ts:28
User’s display name, if set
id:
string
Defined in: package/src/classes/User.ts:31
Unique user ID snowflake
rawData
Section titled “rawData”rawData:
APIUser
Defined in: package/src/classes/User.ts:34
Raw API user data as-is
system
Section titled “system”system:
boolean=false
Defined in: package/src/classes/User.ts:37
Whether this user is an official Discord system account
username
Section titled “username”username:
string
Defined in: package/src/classes/User.ts:40
The user’s username (without discriminator)
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get tag():
string
Defined in: package/src/classes/User.ts:97
User’s username with discriminator (if has one, e.g. example#1234) or just the username if there’s no discriminator (e.g. example)
Returns
Section titled “Returns”string
Methods
Section titled “Methods”avatarURL()
Section titled “avatarURL()”avatarURL(
props):string|null
Defined in: package/src/classes/User.ts:72
Returns the CDN URL for the user’s avatar, or null if not set
Parameters
Section titled “Parameters”Options such as size and format
Returns
Section titled “Returns”string | null
CDN URL or null
toString()
Section titled “toString()”toString():
string
Defined in: package/src/classes/User.ts:104
Returns
Section titled “Returns”string
Mention string for the user, e.g. <@USERID>