Skip to content

GuildMember

Defined in: packages/structures/src/resources.ts:15

A Discord guild member.

new GuildMember(data, context?): GuildMember

Defined in: packages/structures/src/resources.ts:41

Creates a guild member from Discord data.

Discord guild-member payload.

string | null

string | null

number

string

string

string | null

boolean

string

string | null

string[]

{ avatar?: string | null; bot?: boolean; discriminator?: string; global_name?: string | null; id: string; public_flags?: number; system?: boolean; username: string; }

string | null

boolean

string

string | null

string

number

boolean

string

ResourceContext

GuildMember

If the guild ID is invalid.

If joined_at is invalid.

avatarHash: string | null

Defined in: packages/structures/src/resources.ts:29

Member-specific avatar hash, if set.


flags: number

Defined in: packages/structures/src/resources.ts:35

Member flags bitfield.


readonly guildId: string

Defined in: packages/structures/src/resources.ts:19

Guild containing the member.


optional joinedAt?: Date

Defined in: packages/structures/src/resources.ts:27

Member join timestamp.


nickname: string | null

Defined in: packages/structures/src/resources.ts:21

Nickname, if configured.


pending: boolean

Defined in: packages/structures/src/resources.ts:25

Whether the member is pending membership screening.


premiumSince: Date | null

Defined in: packages/structures/src/resources.ts:31

When the member started boosting the guild.


readonly roleIds: string[]

Defined in: packages/structures/src/resources.ts:23

Role IDs assigned to the member.


timedOutUntil: Date | null

Defined in: packages/structures/src/resources.ts:33

When the member’s timeout expires (null if not timed out).


readonly user: User

Defined in: packages/structures/src/resources.ts:17

User represented by the member.

get displayName(): string

Defined in: packages/structures/src/resources.ts:205

Effective member display name — nickname, falling back to user display name.

string


get isTimedOut(): boolean

Defined in: packages/structures/src/resources.ts:210

Whether this member is currently timed out.

boolean


get permissions(): PermissionsBitField

Defined in: packages/structures/src/resources.ts:97

The member’s permissions. Discord sends them with interactions (already resolved for the channel); anywhere else they are computed at guild level from the cached roles each time they are read, so they follow role changes. Empty when the guild’s roles are not cached.

Interaction permissions are used as Discord sent them: Discord computes them, so the local timeout mask is not applied on top.

PermissionsBitField

addRole(roleId, reason?): Promise<void>

Defined in: packages/structures/src/resources.ts:185

Gives this member a role.

string

Role ID.

string

Audit-log reason.

Promise<void>


avatarURL(options?): string | null

Defined in: packages/structures/src/resources.ts:215

Returns the member-specific avatar URL, falling back to the user’s avatar, or null if none.

ImageURLOptions = {}

string | null


ban(options?): Promise<void>

Defined in: packages/structures/src/resources.ts:137

Bans this member.

Audit-log reason and seconds of messages to delete.

number

string

Promise<void>


displayAvatarURL(options?): string

Defined in: packages/structures/src/resources.ts:227

Returns the resolved avatar URL — member avatar, user avatar, or default.

ImageURLOptions = {}

string


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

Defined in: packages/structures/src/resources.ts:144

Edits this member (nickname, roles, voice state, timeout).

Record<string, unknown>

Discord member fields.

string

Audit-log reason.

Promise<GuildMember>


kick(reason?): Promise<void>

Defined in: packages/structures/src/resources.ts:132

Kicks this member.

string

Audit-log reason.

Promise<void>


permissionsIn(channelId): PermissionsBitField | null

Defined in: packages/structures/src/resources.ts:111

The member’s permissions in a channel, with its overwrites. Null when the channel or guild is not cached.

string

Channel ID.

PermissionsBitField | null


removeRole(roleId, reason?): Promise<void>

Defined in: packages/structures/src/resources.ts:195

Takes a role from this member.

string

Role ID.

string

Audit-log reason.

Promise<void>


setNickname(nickname, reason?): Promise<GuildMember>

Defined in: packages/structures/src/resources.ts:177

Sets or clears (null) this member’s nickname.

string | null

New nickname.

string

Audit-log reason.

Promise<GuildMember>


timeout(milliseconds, reason?): Promise<GuildMember>

Defined in: packages/structures/src/resources.ts:157

Times this member out, or clears the timeout with null.

number | null

Timeout length (Discord allows up to 28 days).

string

Audit-log reason.

Promise<GuildMember>


toString(): string

Defined in: packages/structures/src/resources.ts:232

Returns the Discord user mention for this member.

string