Class

GuildBan

Represents a ban in a guild.

Extends Base

Constructor

new GuildBan(client: Client, data: APIBan & { guild_id?: string }, guildId: string)

client: Client
data: APIBan & { guild_id?: string }API ban from GET /guilds/{id}/bans or gateway GUILD_BAN_ADD
guildId: string

Name	Type	Description
clientread-only	`Client`
expiresAtread-only	`Date \| null`	When a temporary ban expires. Null for permanent bans.
guildIdread-only	`string`
reasonread-only	`string \| null`
userread-only	`User`

reason?: string → Promise<void>

Remove this ban (unban the user). Requires Ban Members permission.

await guildBan.unban();