Constructor
# new AntiRaid(client, options)
Name | Type | Description |
---|---|---|
client |
Client | The Discord Client |
options |
AntiRaidOptions | The Antiraid options |
Members
# actionType :AUDIT_LOG
The Discord Audit Logs Action Type
- AUDIT_LOG
# client :Client
The Discord Client
- Client
# cooldown :Collection
The Antiraid cooldown
- Collection
# options :AntiRaidOptions
The Antiraid options
Methods
# addCaseToCooldown(member, event, oldCase, startAt) → {Promise.<any>}
Add Case to Cooldown
Name | Type | Description |
---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
event |
string | Event Name |
oldCase |
Cooldown | Old Cooldown object |
startAt |
number | Timestamp of Event |
- Type
- Promise.<any>
# checkExempt(member, eventopt) → {boolean}
Check If member or event is exempted or if member has exempted role
Name | Type | Attributes | Description |
---|---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
|
event |
string |
<optional> |
Event Name |
- Type
- boolean
let member = message.guild.members.cache.get("id");
antiraid.checkExempt(member)
# getCooldown(id) → {Array.<Cooldown>}
Get Cooldown Array from Antiraid Cache
Name | Type | Description |
---|---|---|
id |
string | Discord Guild ID |
- Type
- Array.<Cooldown>
# getOptionsFromDB(id) → {AntiRaidOptions}
Get Guild Options from DB
Name | Type | Description |
---|---|---|
id |
string | Discord Guild ID |
AntiRaid Options get from DB
- Type
- AntiRaidOptions
# punish(member) → {Promise.<any>}
Ban, kick or Remove all roles of member
Name | Type | Description |
---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
- Type
- Promise.<any>
antiraid.punish(Member)
# punishable(member, caseToCheck) → {Promise.<boolean>}
Check if member is eligible to sanction
Name | Type | Description |
---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
caseToCheck |
Cooldown | Cooldown object to check |
Member is eligible to sanction
- Type
- Promise.<boolean>
# saveCooldown(id, cooldownToSave) → {void}
Save Cooldown Array to Cache
Name | Type | Description |
---|---|---|
id |
string | Discord Guild ID |
cooldownToSave |
Array.<Cooldown> |
- Type
- void
# search(member, event) → {Cooldown}
Get Member's cases from cache
Name | Type | Description |
---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
event |
string | Event Name |
Member's Cases fetched from cache
- Type
- Cooldown
Events
# punish
Emitted when a member got punished.
Name | Type | Description |
---|---|---|
member |
GuildMember | Discord GuildMember resolvable |
reason |
AntiRaidOptions.reason | Punishment reason |
sanction |
string | Sanction type (ban|kick|unrank) |
// Print args in Console
antiraid.on("punish", (member, reason, sanction) => {
member.guild.channels.cache.get("848500695506223107").send(`${member.user.username} got banned for raid attempt`)
})