GuildMember

A GuildMember is a user as a member of one server: the same person has one User, and one GuildMember per server they are in. You get one as the member of a command used in a server, with the events about members and messages, and from guild.members or guild.fetchMember().

import type { GuildMember } from 'chapterjs';

async function mute(member: GuildMember, moderator: GuildMember) {
  if (!moderator.permissions.has('ModerateMembers')) return 'You are not allowed to do that.';
  if (!moderator.isHigherThan(member)) return 'You can only time out members below you.';
  await member.timeout(10 * 60 * 1000, `Timed out by ${moderator.displayName}`);
  return `${member.displayName} is timed out for 10 minutes.`;
}

How your functions receive a member is in Commands and Events. Which members the bot remembers is in Memory.

Properties

Snowflake

The id of the server.

User

The account of the member.

Snowflake

The id of the user.

Guild

The server the member is in.

string | null

The nickname of the member in this server, when they have one.

string

The name to show: nickname, or display name, or username.

readonly Snowflake[]

The ids of the roles of the member (@everyone is not listed).

Role[]

The roles of the member, @everyone included, highest first.

Role

The highest role of the member in the hierarchy; @everyone at least.

VoiceChannel | null

The voice channel the member is in; null when they are in none. The bot knows it when Discord sends it voice states: in a project with a file that joins a voice channel or listens to a voice event.

Date | null

When the member joined the server.

Date | null

Since when the member boosts the server.

boolean

Whether the member has not passed the membership screening yet.

Date | null

Until when the member is timed out; null when they are not.

boolean

Whether the member is timed out right now.

boolean

Whether the member owns the server.

Permissions

What the member can do in the server (channels may change it: see permissionsIn). See Permissions.

Helpers

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

permissionsIn()

permissionsIn(channel: GuildChannel): Permissions

What the member can do in a channel of the server.

avatarURL()

avatarURL(options?: ImageOptions): string

The avatar of the member in this server, or else of their account. See ImageOptions.

isHigherThan()

isHigherThan(other: GuildMember): boolean

Whether this member is above another one in the role hierarchy, which is what allows to kick, ban or rename them. Discord documentation

hasRole()

hasRole(role: Snowflake | Role): boolean

Whether the member has a role.

toString()

toString(): string

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

toJSON()

toJSON(): object

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

Actions

edit()

edit(options: MemberEditOptions, reason?: string): Promise<GuildMember>

Changes the member. See MemberEditOptions. Discord documentation

setNick()

setNick(nick: string | null, reason?: string): Promise<GuildMember>

Changes the nickname of the member; null removes it.

addRole()

addRole(role: Snowflake | Role, reason?: string): Promise<void>

Gives a role to the member. Discord documentation

removeRole()

removeRole(role: Snowflake | Role, reason?: string): Promise<void>

Takes a role from the member. Discord documentation

timeout()

timeout(duration: number, reason?: string): Promise<GuildMember>

Prevents the member from writing, reacting and speaking for a while. duration is how long, in milliseconds (28 days at most).

removeTimeout()

removeTimeout(reason?: string): Promise<GuildMember>

Ends the timeout of the member.

kick()

kick(reason?: string): Promise<void>

Removes the member from the server; they can come back with an invite. Discord documentation

ban()

ban(options?: BanOptions): Promise<void>

Bans the member from the server. See BanOptions. Discord documentation

send()

send(message: MessageInput): Promise<Message>

Sends a private message to the member. See MessageInput.

Types

BanOptions

What ban() takes, on a member or on a server. Every field can be left out.

string

Why, shown in the audit log of the server.

number

Also deletes the messages the user sent in the last seconds given: from 0 (the default, nothing) to 604800 (7 days).

MemberEditOptions

What edit() takes. Every field can be left out: only what you pass changes.

string | null

The nickname; null removes it.

(Snowflake | Role)[]

Replaces every role of the member.

boolean

Mutes the member in voice channels.

boolean

Deafens the member in voice channels.

Snowflake | { id: Snowflake } | null

Moves the member to another voice channel; null disconnects them.

Date | null

Until when the member is timed out; null ends the timeout.

Reference

Your files

Structures

Types

CLI

Properties

Helpers

permissionsIn()

avatarURL()

isHigherThan()

hasRole()

toString()

toJSON()

Actions

edit()

setNick()

addRole()

removeRole()

timeout()

removeTimeout()

kick()

ban()

send()

Types

BanOptions

MemberEditOptions