User

A User is a Discord account, the same in every server. You get one as the user of a command, as message.author, as member.user and as the user of the memberLeave event. For what is specific to one server (nickname, roles, permissions), see GuildMember.

import type { User } from 'chapterjs';

async function greet(user: User) {
  if (user.bot) return;
  await user.send({
    content: `Hi ${user.displayName}!`,
    embeds: [{ thumbnail: { url: user.avatarURL({ size: 256 }) } }],
  });
}

How your functions receive a user is in Commands and Events. What a private message can hold is in Messages.

Sending a private message fails when the user has closed their private messages or shares no server with the bot. Catch the error when that is fine for you: see Errors.

Properties

Snowflake

The unique id Discord gave it.

Date

When it was created: a Discord id contains its creation date.

string

The unique name of the account (@name).

string | null

The name shown in Discord, when the user chose one.

string

The name to show: the display name, or else the username.

string

"0" for users on the current username system.

boolean

Whether the account is a bot.

boolean

Whether the account is an official Discord system account.

string | null

The hash of the avatar; use avatarURL() to get the image.

string | null

The hash of the banner; use bannerURL() to get the image.

number | null

The banner color, as a number (0xff0000).

Locale | null

Only known for the bot itself. See Locale.

UserFlagName[]

The public badges of the account, by name. See UserFlagName.

Helpers

These read what the bot remembers: they never send a request.

avatarURL()

avatarURL(options?: ImageOptions): string

The URL of the avatar; of the default one when none is set. See ImageOptions.

bannerURL()

bannerURL(options?: ImageOptions): string | null

The URL of the banner, when one is set. See ImageOptions.

toString()

toString(): string

<@id>: mentions the user when put in a message.

toJSON()

toJSON(): object

The data of Discord as a plain object, with camelCase names.

Reading from Discord

fetch()

fetch(): Promise<User>

Asks Discord for the latest data of this user.

Actions

createDM()

createDM(): Promise<DMChannel>

Opens the private conversation with this user. See DMChannel. Discord documentation

send()

send(message: MessageInput): Promise<Message>

Sends a private message to this user. See MessageInput.

Types

UserFlagName

The name of a public badge, as flags lists them: one of the keys of UserFlags.

Name	Badge
`Staff`	Discord Employee
`Partner`	Partnered Server Owner
`Hypesquad`	HypeSquad Events Member
`BugHunterLevel1`	Bug Hunter Level 1
`HypesquadOnlineHouse1`	House Bravery Member
`HypesquadOnlineHouse2`	House Brilliance Member
`HypesquadOnlineHouse3`	House Balance Member
`PremiumEarlySupporter`	Early Nitro Supporter
`TeamPseudoUser`	User is a team
`BugHunterLevel2`	Bug Hunter Level 2
`VerifiedBot`	Verified Bot
`VerifiedDeveloper`	Early Verified Bot Developer
`CertifiedModerator`	Moderator Programs Alumni
`BotHttpInteractions`	Bot uses only HTTP interactions and is shown in the online member list

Discord documentation ImageOptions is in Helpers.

Reference

Your files

Structures

Types

CLI

Properties

Helpers

avatarURL()

bannerURL()

toString()

toJSON()

Reading from Discord

fetch()

Actions

createDM()

send()

Types

UserFlagName