Interface PartialUser

interface PartialUser {
    accentColor: undefined | null | number;
    avatar: null | string;
    avatarDecoration: null | string;
    avatarDecorationData: null | AvatarDecorationData;
    banner: undefined | null | string;
    bot: boolean;
    client: Client<true>;
    collectibles: null | Collectibles;
    createdAt: Date;
    createdTimestamp: number;
    defaultAvatarURL: string;
    discriminator: null;
    displayName: string;
    dmChannel: null | DMChannel;
    flags: null | Readonly<UserFlagsBitField>;
    globalName: null | string;
    hexAccentColor: undefined | null | `#${string}`;
    id: string;
    partial: true;
    primaryGuild: null | UserPrimaryGuild;
    system: boolean;
    tag: null;
    username: null;
    avatarDecorationURL(options?: BaseImageURLOptions): null | string;
    avatarURL(options?: ImageURLOptions): null | string;
    bannerURL(options?: ImageURLOptions): undefined | null | string;
    createDM(force?: boolean): Promise<DMChannel>;
    deleteDM(): Promise<DMChannel>;
    displayAvatarURL(options?: ImageURLOptions): string;
    equals(user: User): boolean;
    fetch(force?: boolean): Promise<User>;
    fetchFlags(force?: boolean): Promise<UserFlagsBitField>;
    guildTagBadgeURL(options?: ImageURLOptions): null | string;
    send(
        options: string | MessagePayload | MessageCreateOptions,
    ): Promise<Message<false>>;
    toJSON(...props: Record<string, string | boolean>[]): unknown;
    toString(): `<@${string}>`;
    valueOf(): string;
}

Hierarchy (View Summary)

Properties

accentColor avatar avatarDecoration avatarDecorationData banner bot client collectibles createdAt createdTimestamp defaultAvatarURL discriminator displayName dmChannel flags globalName hexAccentColor id partial primaryGuild system tag username

Methods

avatarDecorationURL avatarURL bannerURL createDM deleteDM displayAvatarURL equals fetch fetchFlags guildTagBadgeURL send toJSON toString valueOf

Properties

accentColor

accentColor: undefined | null | number

avatar

avatar: null | string

avatarDecoration

avatarDecoration: null | string

Deprecated

Use User.avatarDecorationData instead

avatarDecorationData

avatarDecorationData: null | AvatarDecorationData

banner

banner: undefined | null | string

bot

bot: boolean

Readonlyclient

client: Client<true>

collectibles

collectibles: null | Collectibles

createdAt

createdAt: Date

createdTimestamp

createdTimestamp: number

defaultAvatarURL

defaultAvatarURL: string

discriminator

discriminator: null

displayName

displayName: string

dmChannel

dmChannel: null | DMChannel

flags

flags: null | Readonly<UserFlagsBitField>

globalName

globalName: null | string

hexAccentColor

hexAccentColor: undefined | null | `#${string}`

id

id: string

partial

partial: true

primaryGuild

primaryGuild: null | UserPrimaryGuild

system

system: boolean

tag

tag: null

username

username: null

Methods

avatarDecorationURL

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

    Parameters

    Returns null | string

avatarURL

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

    Parameters

    Returns null | string

bannerURL

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

    Parameters

    Returns undefined | null | string

createDM

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

    Parameters

    • Optionalforce: boolean

    Returns Promise<DMChannel>

deleteDM

displayAvatarURL

  • displayAvatarURL(options?: ImageURLOptions): string

    Parameters

    Returns string

equals

  • equals(user: User): boolean

    Parameters

    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

    Returns null | string

send

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

Settings

Member Visibility

On This Page

Properties
Methods