Skip to content

MemberHandle

Defined in: packages/core/src/handles.ts:192

A guild member, by guild id and user id. Made by bot.member(guildId, userId).

new MemberHandle(bot, guildId, userId): MemberHandle

Defined in: packages/core/src/handles.ts:193

Client

string

string

MemberHandle

readonly guildId: string

Defined in: packages/core/src/handles.ts:195


readonly userId: string

Defined in: packages/core/src/handles.ts:196

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

Defined in: packages/core/src/handles.ts:233

string

string

Promise<void>


ban(options?): Promise<void>

Defined in: packages/core/src/handles.ts:223

BanOptions

Promise<void>


edit(options): Promise<GuildMember>

Defined in: packages/core/src/handles.ts:230

Changes nickname, roles, mute or deafen; put the audit-log reason in options.reason.

MemberEditOptions

Promise<GuildMember>


fetch(): Promise<GuildMember>

Defined in: packages/core/src/handles.ts:209

Promise<GuildMember>

Handle.fetch


get(): Promise<GuildMember>

Defined in: packages/core/src/handles.ts:206

Promise<GuildMember>

Handle.get


guild(): GuildHandle

Defined in: packages/core/src/handles.ts:213

GuildHandle


kick(reason?): Promise<void>

Defined in: packages/core/src/handles.ts:220

string

Promise<void>


peek(): GuildMember | undefined

Defined in: packages/core/src/handles.ts:203

GuildMember | undefined

Handle.peek


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

Defined in: packages/core/src/handles.ts:236

string

string

Promise<void>


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

Defined in: packages/core/src/handles.ts:243

Times the member out for duration ("10m", "2h", 90_000), or lifts the timeout with null.

Duration | null

string

Promise<GuildMember>


unban(reason?): Promise<void>

Defined in: packages/core/src/handles.ts:226

string

Promise<void>


user(): UserHandle

Defined in: packages/core/src/handles.ts:216

UserHandle