Class User

constructor

• new User(data, client): User

• Parameters

  • data: RawUser

  • client: Client<ClientEvents>

  Returns User

Optional accentColor

avatar

Optional avatarDecoration

Optional banner

bot

discriminator

globalName

publicFlags

system

username

defaultAvatar

• get defaultAvatar(): number

• The default avatar value of this user.

  Returns number

isMigrated

• get isMigrated(): boolean

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

  Returns boolean

mention

• get mention(): string

• A string that will mention this user.

  Returns string

tag

• get tag(): string

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

  Returns string

avatarDecorationURL

• avatarDecorationURL(size?): null | string

• 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

• avatarURL(format?, size?): string

• 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

• bannerURL(format?, size?): null | string

• 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

• createDM(): Promise<PrivateChannel>

• Create a direct message with this user.

  Returns Promise<PrivateChannel>

createTestEntitlement

• createTestEntitlement(skuID, applicationID?): Promise<TestEntitlement>

• Create a test entitlement for this user.

  Parameters

  • skuID: string

    The ID of the SKU to create an entitlement for.

  • Optional applicationID: string

    The ID of the application to create the entitlement for. If present, defaults to the logged in client's application id.

  Returns Promise<TestEntitlement>

defaultAvatarURL

• defaultAvatarURL(): string

• The url of this user's default avatar.

  Returns string

getEntitlements

• getEntitlements(options?, applicationID?): Promise<(Entitlement | TestEntitlement)[]>

• Get the entitlements for this guild.

  Parameters

  • Optional options: Omit<SearchEntitlementsOptions, "userID">

    The options for getting the entitlements.

  • Optional applicationID: string

  Returns Promise<(Entitlement | TestEntitlement)[]>

toJSON

• toJSON(): JSONUser

• Returns JSONUser