Class User

Represents a user.

Hierarchy

Accessors

createdAt defaultAvatar isMigrated mention tag

Constructors

constructor

Methods

avatarDecorationURL avatarURL bannerURL createDM defaultAvatarURL toJSON toString generateID getCreatedAt getDiscordEpoch

Properties

accentColor? avatar avatarDecoration? banner? bot client discriminator globalName id publicFlags system username

Accessors

createdAt

defaultAvatar

isMigrated

  • get isMigrated(): boolean

  • If this user has migrated to the new username system.

    Returns boolean

mention

tag

  • get tag(): string

  • This user's unique username, if migrated, else a combination of the user's username and discriminator.

    Returns string

Constructors

constructor

Methods

avatarDecorationURL

  • The url of this user's avatar decoration. This will always be a png. Discord does not combine the decoration and their current avatar for you. This is ONLY the decoration.

    Parameters

    • Optional size: number

      The dimensions of the image.

    Returns null | string

    Note

    As of 12/8/2022 (Dec 8) avatar_decoration is only visible to bots if they set an X-Super-Properties header with a client_build_number ~162992. You can do this via the rest.superProperties option.

avatarURL

  • The url of this user's avatar (or default avatar, if they have not set an avatar).

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns string

bannerURL

  • The url of this user's banner.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

createDM

defaultAvatarURL

toJSON

toString

Static generateID

Static getCreatedAt

Static getDiscordEpoch

Properties

Optional accentColor

accentColor?: null | number

The user's banner color. If this member was received via the gateway, this will never be present.

avatar

avatar: null | string

The user's avatar hash.

Optional avatarDecoration

avatarDecoration?: null | string

The hash of this user's avatar decoration. This will always resolve to a png.

Optional banner

banner?: null | string

The user's banner hash. If this member was received via the gateway, this will never be present.

bot

bot: boolean

If this user is a bot.

client

client: Client<ClientEvents>

discriminator

discriminator: string

The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0".

globalName

globalName: null | string

The user's display name, if set.

id

id: string

publicFlags

publicFlags: number

The user's public flags.

system

system: boolean

If this user is an official discord system user.

username

username: string

The user's username.

On This Page