User
Defined in: packages/structures/src/base.ts:182
Common Discord snowflake-backed structure.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new User(
data):User
Defined in: packages/structures/src/base.ts:190
Parameters
Section titled “Parameters”Returns
Section titled “Returns”User
Overrides
Section titled “Overrides”Properties
Section titled “Properties”avatar
Section titled “avatar”avatar:
string|null
Defined in: packages/structures/src/base.ts:185
bot:
boolean
Defined in: packages/structures/src/base.ts:186
discriminator
Section titled “discriminator”discriminator:
string|null
Defined in: packages/structures/src/base.ts:189
flags:
number
Defined in: packages/structures/src/base.ts:188
globalName
Section titled “globalName”globalName:
string|null
Defined in: packages/structures/src/base.ts:184
readonlyid:string
Defined in: packages/structures/src/base.ts:12
Inherited from
Section titled “Inherited from”system
Section titled “system”system:
boolean
Defined in: packages/structures/src/base.ts:187
username
Section titled “username”username:
string
Defined in: packages/structures/src/base.ts:183
Accessors
Section titled “Accessors”createdAt
Section titled “createdAt”Get Signature
Section titled “Get Signature”get createdAt():
Date
Defined in: packages/structures/src/base.ts:29
Returns the timestamp this snowflake was created at.
Returns
Section titled “Returns”Date
Inherited from
Section titled “Inherited from”createdTimestamp
Section titled “createdTimestamp”Get Signature
Section titled “Get Signature”get createdTimestamp():
number
Defined in: packages/structures/src/base.ts:25
Milliseconds since the Unix epoch at which this snowflake was created.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”BaseStructure.createdTimestamp
displayName
Section titled “displayName”Get Signature
Section titled “Get Signature”get displayName():
string
Defined in: packages/structures/src/base.ts:206
Effective display name — global name, falling back to username.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”avatarURL()
Section titled “avatarURL()”avatarURL(
options?):string|null
Defined in: packages/structures/src/base.ts:210
Returns the user’s avatar URL, or null if they have no avatar.
Parameters
Section titled “Parameters”options?
Section titled “options?”ImageURLOptions = {}
Returns
Section titled “Returns”string | null
defaultAvatarURL()
Section titled “defaultAvatarURL()”defaultAvatarURL():
string
Defined in: packages/structures/src/base.ts:215
Returns the default avatar URL based on the user’s discriminator/snowflake.
Returns
Section titled “Returns”string
displayAvatarURL()
Section titled “displayAvatarURL()”displayAvatarURL(
options?):string
Defined in: packages/structures/src/base.ts:222
Returns the avatar URL if available, falling back to the default avatar URL.
Parameters
Section titled “Parameters”options?
Section titled “options?”ImageURLOptions = {}
Returns
Section titled “Returns”string
toString()
Section titled “toString()”toString():
string
Defined in: packages/structures/src/base.ts:226
Returns the Discord mention string. Used automatically in template literals.
Returns
Section titled “Returns”string