AntiRaid

AntiRaid

AntiRaid

Constructor

# new AntiRaid(client, options)

Parameters:
Name Type Description
client Client

The Discord Client

options AntiRaidOptions

The Antiraid options

Members

# actionType :AUDIT_LOG

The Discord Audit Logs Action Type

Type:
  • AUDIT_LOG

# client :Client

The Discord Client

Type:
  • Client

# cooldown :Collection

The Antiraid cooldown

Type:
  • Collection

# options :AntiRaidOptions

The Antiraid options

Methods

# addCaseToCooldown(member, event, oldCase, startAt) → {Promise.<any>}

Add Case to Cooldown

Parameters:
Name Type Description
member GuildMember

Discord GuildMember resolvable

event string

Event Name

oldCase Cooldown

Old Cooldown object

startAt number

Timestamp of Event

Returns:
Type
Promise.<any>

# checkExempt(member, eventopt) → {boolean}

Check If member or event is exempted or if member has exempted role

Parameters:
Name Type Attributes Description
member GuildMember

Discord GuildMember resolvable

event string <optional>

Event Name

Returns:
Type
boolean
Example
let member = message.guild.members.cache.get("id");
antiraid.checkExempt(member)

# getCooldown(id) → {Array.<Cooldown>}

Get Cooldown Array from Antiraid Cache

Parameters:
Name Type Description
id string

Discord Guild ID

Returns:
Type
Array.<Cooldown>

# getOptionsFromDB(id) → {AntiRaidOptions}

Get Guild Options from DB

Parameters:
Name Type Description
id string

Discord Guild ID

Returns:

AntiRaid Options get from DB

Type
AntiRaidOptions

# punish(member) → {Promise.<any>}

Ban, kick or Remove all roles of member

Parameters:
Name Type Description
member GuildMember

Discord GuildMember resolvable

Returns:
Type
Promise.<any>
Example
antiraid.punish(Member)

# punishable(member, caseToCheck) → {Promise.<boolean>}

Check if member is eligible to sanction

Parameters:
Name Type Description
member GuildMember

Discord GuildMember resolvable

caseToCheck Cooldown

Cooldown object to check

Returns:

Member is eligible to sanction

Type
Promise.<boolean>

# saveCooldown(id, cooldownToSave) → {void}

Save Cooldown Array to Cache

Parameters:
Name Type Description
id string

Discord Guild ID

cooldownToSave Array.<Cooldown>
Returns:
Type
void

Get Member's cases from cache

Parameters:
Name Type Description
member GuildMember

Discord GuildMember resolvable

event string

Event Name

Returns:

Member's Cases fetched from cache

Type
Cooldown

Events

# punish

Emitted when a member got punished.

Parameters:
Name Type Description
member GuildMember

Discord GuildMember resolvable

reason AntiRaidOptions.reason

Punishment reason

sanction string

Sanction type (ban|kick|unrank)

Example
// 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`)
  })