GuildMember
Defined in: packages/structures/src/resources.ts:15
A Discord guild member.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuildMember(
data,context?):GuildMember
Defined in: packages/structures/src/resources.ts:41
Creates a guild member from Discord data.
Parameters
Section titled “Parameters”Discord guild-member payload.
avatar?
Section titled “avatar?”string | null
communication_disabled_until?
Section titled “communication_disabled_until?”string | null
flags?
Section titled “flags?”number
guild_id
Section titled “guild_id”string
joined_at?
Section titled “joined_at?”string
string | null
pending?
Section titled “pending?”boolean
permissions?
Section titled “permissions?”string
premium_since?
Section titled “premium_since?”string | null
roles?
Section titled “roles?”string[]
{ avatar?: string | null; bot?: boolean; discriminator?: string; global_name?: string | null; id: string; public_flags?: number; system?: boolean; username: string; }
user.avatar?
Section titled “user.avatar?”string | null
user.bot?
Section titled “user.bot?”boolean
user.discriminator?
Section titled “user.discriminator?”string
user.global_name?
Section titled “user.global_name?”string | null
user.id
Section titled “user.id”string
user.public_flags?
Section titled “user.public_flags?”number
user.system?
Section titled “user.system?”boolean
user.username
Section titled “user.username”string
context?
Section titled “context?”Returns
Section titled “Returns”GuildMember
Throws
Section titled “Throws”If the guild ID is invalid.
Throws
Section titled “Throws”If joined_at is invalid.
Properties
Section titled “Properties”avatarHash
Section titled “avatarHash”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.
guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/structures/src/resources.ts:19
Guild containing the member.
joinedAt?
Section titled “joinedAt?”
optionaljoinedAt?:Date
Defined in: packages/structures/src/resources.ts:27
Member join timestamp.
nickname
Section titled “nickname”nickname:
string|null
Defined in: packages/structures/src/resources.ts:21
Nickname, if configured.
pending
Section titled “pending”pending:
boolean
Defined in: packages/structures/src/resources.ts:25
Whether the member is pending membership screening.
premiumSince
Section titled “premiumSince”premiumSince:
Date|null
Defined in: packages/structures/src/resources.ts:31
When the member started boosting the guild.
roleIds
Section titled “roleIds”
readonlyroleIds:string[]
Defined in: packages/structures/src/resources.ts:23
Role IDs assigned to the member.
timedOutUntil
Section titled “timedOutUntil”timedOutUntil:
Date|null
Defined in: packages/structures/src/resources.ts:33
When the member’s timeout expires (null if not timed out).
readonlyuser:User
Defined in: packages/structures/src/resources.ts:17
User represented by the member.
Accessors
Section titled “Accessors”displayName
Section titled “displayName”Get Signature
Section titled “Get Signature”get displayName():
string
Defined in: packages/structures/src/resources.ts:205
Effective member display name — nickname, falling back to user display name.
Returns
Section titled “Returns”string
isTimedOut
Section titled “isTimedOut”Get Signature
Section titled “Get Signature”get isTimedOut():
boolean
Defined in: packages/structures/src/resources.ts:210
Whether this member is currently timed out.
Returns
Section titled “Returns”boolean
permissions
Section titled “permissions”Get Signature
Section titled “Get Signature”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.
Returns
Section titled “Returns”Methods
Section titled “Methods”addRole()
Section titled “addRole()”addRole(
roleId,reason?):Promise<void>
Defined in: packages/structures/src/resources.ts:185
Gives this member a role.
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
Role ID.
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
avatarURL()
Section titled “avatarURL()”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.
Parameters
Section titled “Parameters”options?
Section titled “options?”ImageURLOptions = {}
Returns
Section titled “Returns”string | null
ban(
options?):Promise<void>
Defined in: packages/structures/src/resources.ts:137
Bans this member.
Parameters
Section titled “Parameters”options?
Section titled “options?”Audit-log reason and seconds of messages to delete.
deleteMessageSeconds?
Section titled “deleteMessageSeconds?”number
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
displayAvatarURL()
Section titled “displayAvatarURL()”displayAvatarURL(
options?):string
Defined in: packages/structures/src/resources.ts:227
Returns the resolved avatar URL — member avatar, user avatar, or default.
Parameters
Section titled “Parameters”options?
Section titled “options?”ImageURLOptions = {}
Returns
Section titled “Returns”string
edit()
Section titled “edit()”edit(
options,reason?):Promise<GuildMember>
Defined in: packages/structures/src/resources.ts:144
Edits this member (nickname, roles, voice state, timeout).
Parameters
Section titled “Parameters”options
Section titled “options”Record<string, unknown>
Discord member fields.
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<GuildMember>
kick()
Section titled “kick()”kick(
reason?):Promise<void>
Defined in: packages/structures/src/resources.ts:132
Kicks this member.
Parameters
Section titled “Parameters”reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
permissionsIn()
Section titled “permissionsIn()”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.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
Channel ID.
Returns
Section titled “Returns”PermissionsBitField | null
removeRole()
Section titled “removeRole()”removeRole(
roleId,reason?):Promise<void>
Defined in: packages/structures/src/resources.ts:195
Takes a role from this member.
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
Role ID.
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
setNickname()
Section titled “setNickname()”setNickname(
nickname,reason?):Promise<GuildMember>
Defined in: packages/structures/src/resources.ts:177
Sets or clears (null) this member’s nickname.
Parameters
Section titled “Parameters”nickname
Section titled “nickname”string | null
New nickname.
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<GuildMember>
timeout()
Section titled “timeout()”timeout(
milliseconds,reason?):Promise<GuildMember>
Defined in: packages/structures/src/resources.ts:157
Times this member out, or clears the timeout with null.
Parameters
Section titled “Parameters”milliseconds
Section titled “milliseconds”number | null
Timeout length (Discord allows up to 28 days).
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<GuildMember>
toString()
Section titled “toString()”toString():
string
Defined in: packages/structures/src/resources.ts:232
Returns the Discord user mention for this member.
Returns
Section titled “Returns”string