From 9443dad4f17fb553a7dacb318af5790c99bbf16f Mon Sep 17 00:00:00 2001 From: Scraayp Date: Mon, 12 Sep 2022 15:35:52 +0200 Subject: [PATCH] v2.8.0 docs! --- docs/AntiSpamClient.html | 383 +++++++++++++++++++++------------------ docs/global.html | 8 +- docs/index.html | 4 +- 3 files changed, 212 insertions(+), 183 deletions(-) diff --git a/docs/AntiSpamClient.html b/docs/AntiSpamClient.html index 44fdc1b..3f51ceb 100644 --- a/docs/AntiSpamClient.html +++ b/docs/AntiSpamClient.html @@ -24,7 +24,7 @@
@@ -509,7 +509,9 @@
Returns:
Example
-
client.on('message', (msg) => {
	antiSpam.message(msg);
});
+
client.on('message', (msg) => {
+	antiSpam.message(msg);
+});
@@ -605,7 +607,7 @@

resetsendActionMessage(message, action)

+

(async) userleave(member) → {Promise.<boolean>}

@@ -613,7 +615,7 @@

send
-

Send action message in the channel or dm

+

Checks if the user left the server to remove him from the cache!

@@ -688,39 +690,13 @@

Parameters:
- message - - - - - -Discord.Message - - - - - - - - - - - - - - - - - - - - action + member -String +Discord.GuildMember @@ -731,7 +707,7 @@
Parameters:
- +

The member to remove from the cache.

@@ -760,88 +736,75 @@
Returns:
- -
-

boolean.

-
- - -
- - - - - - +
+
+ Type: +
+
- -
- - - - -

(async) userleave(member) → {Promise.<boolean>}

- +Promise.<boolean> - +
+
-
-

Checks if the user left the server to remove him from the cache!

+
+

Whether the member has been removed

- - - - -
- +
- - - - - +
+
Example
- +
client.on('guildMemberRemove', (member) => {
+	antiSpam.userleave(member);
+});
- +
+ + +

Events

- + + +
- +

banAdd

- +
+

Emitted when a member gets banned.

+
+
Properties:
-
Parameters:
- +
@@ -879,131 +842,47 @@
Parameters:
- + - - -
-

The member to remove from the cache.

- -

The member that was banned.

- - - - - - - - - - - - - - - - -
-
Returns:
- -
-
- Type: -
-
- -Promise.<boolean> - - -
-
- - -
-

Whether the member has been removed

-
- -
- - - - - -
-
Example
- -
client.on('guildMemberRemove', (member) => {
	antiSpam.userleave(member);
});
- -
-
- - - - - - -

Events

- - + + + channel -
- - - - -

banAdd

- - - - - - -
-

Emitted when a member gets banned.

-
- - - + + + +Discord.TextChannel -
Properties:
- + + - - - - - - + - + - + + - - - - - - + + @@ -1157,6 +1036,56 @@
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType

The channel that the spam messages was sent in.

Description
membermessage -Discord.GuildMember +Discord.Message @@ -1013,7 +892,7 @@
Properties:
-

The member that was banned.

The message that was sent as last. Could be used to find the guild object etc..

channel + + +Discord.TextChannel + + + +

The channel that the spam messages was sent in.

message + + +Discord.Message + + + +

The message that was sent as last. Could be used to find the guild object etc..

@@ -1295,6 +1224,56 @@
Properties:
+ + + + channel + + + + + +Discord.TextChannel + + + + + + + + + +

The channel that the spam messages was sent in.

+ + + + + + + + + message + + + + + +Discord.Message + + + + + + + + + +

The message that was sent as last. Could be used to find the guild object etc..

+ + + + + @@ -1433,6 +1412,56 @@
Properties:
+ + + + channel + + + + + +Discord.TextChannel + + + + + + + + + +

The channel that the spam messages was sent in.

+ + + + + + + + + message + + + + + +Discord.Message + + + + + + + + + +

The message that was sent as last. Could be used to find the guild object etc..

+ + + + + @@ -1515,7 +1544,7 @@
Properties:

diff --git a/docs/global.html b/docs/global.html index 4f71f51..0ef5e27 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -801,7 +801,7 @@
Properties:
- modLogsChannelName + modLogsChannel @@ -2374,7 +2374,7 @@
Properties:
- false + true @@ -3433,7 +3433,7 @@
Returns:

diff --git a/docs/index.html b/docs/index.html index cead81c..bbcb3de 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -107,7 +107,7 @@

📝 License