Class UserUtils

Utilities for users.

Index

Methods

getAvatar getName

Methods

`Static`getAvatar

getAvatar(
    id: string,
    avatar?: null | string,
    guildAvatar?: null | string,
    guildId?: null | string,
    discriminator?: null | string,
    options?: CDNImageOptions<"jpeg" | "png" | "webp" | "gif" | "jpg">,
): string
Get a user's avatar.
Parameters
- id: string
  The user's ID.
- Optionalavatar: null | string
  The user's avatar hash.
- OptionalguildAvatar: null | string
  The user's guild avatar hash.
- OptionalguildId: null | string
  The guild ID of the guild avatar hash.
- Optionaldiscriminator: null | string
  The user's discriminator.
- Optionaloptions: CDNImageOptions<"jpeg" | "png" | "webp" | "gif" | "jpg">
  Avatar options. Note that if the user has a default avatar, size will be omitted and the format will be a png.
Returns string
- Defined in src/utils/UserUtils.ts:38

`Static`getName

getName(
    username: string,
    globalName?: null | string,
    nick?: null | string,
    discriminator?: null | string,
): string
Get a user's name.
Parameters
- username: string
  The user's username.
- OptionalglobalName: null | string
  The user's global name (display name).
- Optionalnick: null | string
  The user's nickname in a guild.
- Optionaldiscriminator: null | string
  The user's discriminator.
Returns string
- Defined in src/utils/UserUtils.ts:17