@@ -13,43 +13,54 @@ export interface IRestrictions {
1313}
1414export interface IRawForgeClientOptions extends ClientOptions {
1515 /**
16- * Specifies a folder (path) to load all commands from it
16+ * Specifies a folder (path) to load all commands from it.
1717 */
1818 commands ?: string ;
1919 /**
20- * The discord.js events our bot will use
20+ * The discord.js events the bot will listen to.
2121 */
2222 events ?: CommandType [ ] ;
2323 /**
24- * The prefixes our bot will act upon for command messages
24+ * The prefixes the bot will act upon for command messages.
2525 */
2626 prefixes ?: string [ ] ;
2727 /**
28- * Whether prefixes should be case-insensitive, this only affects letters
28+ * Whether prefixes should be case-insensitive, this only affects letters.
29+ *
30+ * @default false
2931 */
3032 prefixCaseInsensitive ?: boolean ;
3133 /**
32- * Specifies the logs to be received
34+ * Specifies the logs to be received.
35+ *
36+ * @default LogPriority.Medium
3337 */
3438 logLevel ?: LogPriority ;
39+ /**
40+ * Specifies a folder (path) to load all custom functions from it.
41+ */
3542 functions ?: string ;
3643 /**
37- * Allows the bot to execute events triggered by other bots (and itself)
44+ * Allows the bot to execute events triggered by other bots (and itself).
45+ *
46+ * @default false
3847 */
3948 allowBots ?: boolean ;
4049 token ?: string ;
4150 /**
42- * @deprecated use trackers: { invites: true } instead
51+ * @deprecated Use ` trackers: { invites: true }` instead.
4352 */
4453 useInviteSystem ?: boolean ;
4554 disableConsoleErrors ?: boolean ;
4655 /**
47- * This will connect the client to Discord with the mobile status
56+ * This will connect the client to Discord with the mobile status.
57+ *
58+ * @default false
4859 */
4960 mobile ?: boolean ;
5061 trackers ?: ITrackers ;
5162 /**
52- * @deprecated Does not work
63+ * @deprecated Does not work.
5364 */
5465 optionalGuildID ?: boolean ;
5566 extensions ?: ForgeExtension [ ] ;
@@ -58,6 +69,8 @@ export interface IRawForgeClientOptions extends ClientOptions {
5869 * Allows the bot to re-use messages that were edited to find possibly command calls.
5970 * If a number is passed, it's treated as the amount of milliseconds that can pass before
6071 * the message becomes completely unusable.
72+ *
73+ * @default false
6174 */
6275 respondOnEdit ?: number | boolean ;
6376}
0 commit comments