Class BannedMember

BannedMember represents a banned guild member.

Hierarchy

Base<string>
- BannedMember

Index

Constructors

Properties

ban client guildID id member user

Accessors

Methods

Constructors

constructor

new BannedMember(guildID, data, client): BannedMember
Parameters
- guildID: string
  
  ID of the guild.
- data: APIGuildMemberBan
  
  raw data.
- client: Client
  
  client.
Returns BannedMember
Overrides Base.constructor
- Defined in lib/structures/BannedMember.ts:32

Properties

ban

ban: {
    bannedBy: string;
    createdAt: null | Date;
    reason?: string;
}

Information about the banned member (object)

Type declaration

bannedBy: string

ID of the member who banned this member.
createdAt: null | Date

When the member has been banned.
Optional reason?: string

Reason of the ban

client

client: Client

Bot's client.

guildID

guildID: string

Server ID.

id

id: string

Item ID

member

member: null | Member

Banned member, if cached.

user

user: User

Banned user.

Accessors

guild

get guild(): Guild | Promise<Guild>
Getter used to get the message's guild

Note: this can return a promise, make sure to await it before.

Returns Guild | Promise<Guild>
- Defined in lib/structures/BannedMember.ts:72

Methods

toJSON

toJSON(): JSONBannedMember
Returns JSONBannedMember
Overrides Base.toJSON
- Defined in lib/structures/BannedMember.ts:45