Class User

accentColor

avatar

avatarDecoration

avatarDecorationData

banner

bot

Readonlyclient

collectibles

discriminator

flags

globalName

id

primaryGuild

system

username

createdAt

• get createdAt(): Date

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Returns number

defaultAvatarURL

• get defaultAvatarURL(): string

  Returns string

displayName

• get displayName(): string

  Returns string

dmChannel

• get dmChannel(): null | DMChannel

  Returns null | DMChannel

hexAccentColor

• get hexAccentColor(): undefined | null | `#${string}`

  Returns undefined | null | `#${string}`

partial

• get partial(): false

  Returns false

tag

• get tag(): string

  Returns string

avatarDecorationURL

• avatarDecorationURL(options?: BaseImageURLOptions): null | string

  Parameters

  • Optionaloptions: BaseImageURLOptions

  Returns null | string

avatarURL

• avatarURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

bannerURL

• bannerURL(options?: ImageURLOptions): undefined | null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns undefined | null | string

createDM

• createDM(force?: boolean): Promise<DMChannel>

  Parameters

  • Optionalforce: boolean

  Returns Promise<DMChannel>

deleteDM

• deleteDM(): Promise<DMChannel>

  Returns Promise<DMChannel>

displayAvatarURL

• displayAvatarURL(options?: ImageURLOptions): string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns string

equals

• equals(user: User): boolean

  Parameters

  • user: User

  Returns boolean

fetch

• fetch(force?: boolean): Promise<User>

  Parameters

  • Optionalforce: boolean

  Returns Promise<User>

fetchFlags

• fetchFlags(force?: boolean): Promise<UserFlagsBitField>

  Parameters

  • Optionalforce: boolean

  Returns Promise<UserFlagsBitField>

  Deprecated

  This method is deprecated and will be removed in the next major version. Flags may still be retrieved via User.fetch

guildTagBadgeURL

• guildTagBadgeURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

toJSON

• toJSON(...props: Record<string, string | boolean>[]): unknown

  Parameters

  • ...props: Record<string, string | boolean>[]

  Returns unknown

toString

• toString(): `<@${string}>`

  Returns a string representation of an object.

  Returns `<@${string}>`

valueOf

• valueOf(): string

  Returns string