Skip to content

User

Defined in: packages/structures/src/base.ts:182

Common Discord snowflake-backed structure.

new User(data): User

Defined in: packages/structures/src/base.ts:190

UserData

User

BaseStructure.constructor

avatar: string | null

Defined in: packages/structures/src/base.ts:185


bot: boolean

Defined in: packages/structures/src/base.ts:186


discriminator: string | null

Defined in: packages/structures/src/base.ts:189


flags: number

Defined in: packages/structures/src/base.ts:188


globalName: string | null

Defined in: packages/structures/src/base.ts:184


readonly id: string

Defined in: packages/structures/src/base.ts:12

BaseStructure.id


system: boolean

Defined in: packages/structures/src/base.ts:187


username: string

Defined in: packages/structures/src/base.ts:183

get createdAt(): Date

Defined in: packages/structures/src/base.ts:29

Returns the timestamp this snowflake was created at.

Date

BaseStructure.createdAt


get createdTimestamp(): number

Defined in: packages/structures/src/base.ts:25

Milliseconds since the Unix epoch at which this snowflake was created.

number

BaseStructure.createdTimestamp


get displayName(): string

Defined in: packages/structures/src/base.ts:206

Effective display name — global name, falling back to username.

string

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.

ImageURLOptions = {}

string | null


defaultAvatarURL(): string

Defined in: packages/structures/src/base.ts:215

Returns the default avatar URL based on the user’s discriminator/snowflake.

string


displayAvatarURL(options?): string

Defined in: packages/structures/src/base.ts:222

Returns the avatar URL if available, falling back to the default avatar URL.

ImageURLOptions = {}

string


toString(): string

Defined in: packages/structures/src/base.ts:226

Returns the Discord mention string. Used automatically in template literals.

string

BaseStructure.toString