Document some methods and things

packages/core/src/classes/managers/CooldownManager.ts

@@ -1,4 +1,5 @@
 import { Cooldown, CooldownData } from '../structures/Cooldown.js';
+import { RecipleClient } from '../structures/RecipleClient.js';
 import { DataManager } from './DataManager.js';
 
 export interface CooldownSweeperOptions {
@@ -10,6 +11,10 @@ export interface CooldownSweeperOptions {
 export class CooldownManager extends DataManager<Cooldown> {
     private _sweeper?: NodeJS.Timeout;
 
+    constructor(readonly client: RecipleClient) {
+        super();
+    }
+
     public create(data: CooldownData): Cooldown {
         const isExists = this.findCooldown(data);
         if (isExists) return isExists;

packages/core/src/classes/structures/CommandPrecondition.ts

@@ -6,10 +6,32 @@ import { AnyCommandExecuteData } from '../../types/structures.js';
 import { CommandType } from '../../types/constants.js';
 
 export interface CommandPreconditionData {
+    /**
+     * The id of the precondition.
+     * The id only accepts lowercase letters and cannot contain spaces or special characters.
+     */
     id: string;
+    /**
+     * Whether the precondition is disabled.
+     */
     disabled?: boolean;
+    /**
+     * The execute function for context menu commands.
+     * @param execute Execute data for the command.
+     * @param precondition The precondition that is being executed.
+     */
     contextMenuCommandExecute?: (execute: ContextMenuCommandExecuteData, precondition: CommandPrecondition) => Awaitable<CommandPreconditionResultResolvable<ContextMenuCommandExecuteData>>;
+    /**
+     * The execute function for message commands.
+     * @param execute Execute data for the command.
+     * @param precondition The precondition that is being executed.
+     */
     messageCommandExecute?: (execute: MessageCommandExecuteData, precondition: CommandPrecondition) => Awaitable<CommandPreconditionResultResolvable<MessageCommandExecuteData>>;
+    /**
+     * The execute function for slash commands.
+     * @param execute Execute data for the command.
+     * @param precondition The precondition that is being executed.
+     */
     slashCommandExecute?: (execute: SlashCommandExecuteData, precondition: CommandPrecondition) => Awaitable<CommandPreconditionResultResolvable<SlashCommandExecuteData>>;
 }
 
@@ -39,6 +61,10 @@ export class CommandPrecondition implements CommandPreconditionData {
         this.slashCommandExecute = data.slashCommandExecute;
     }
 
+    /**
+     * Sets the disabled state of the precondition.
+     * @param disabled Disabled state of the precondition.
+     */
     public setDisabled(disabled: boolean): this {
         this.disabled = disabled;
         return this;

packages/core/src/classes/structures/Cooldown.ts

@@ -3,11 +3,29 @@ import { CommandType } from '../../types/constants.js';
 import { TextBasedChannel } from 'discord.js';
 
 export interface CooldownData {
+    /**
+     * The user id of the user that the cooldown is for.
+     */
     userId: string;
+    /**
+     * The date that the cooldown ends at.
+     */
     endsAt: Date;
+    /**
+     * The channel id of the channel that the cooldown is for.
+     */
     channelId?: string;
+    /**
+     * The guild id of the guild that the cooldown is for.
+     */
     guildId?: string;
+    /**
+     * The name of the command that the cooldown is for.
+     */
     commandName?: string;
+    /**
+     * The type of the command that the cooldown is for.
+     */
     commandType?: CommandType;
 }
 
@@ -49,6 +67,9 @@ export class Cooldown implements CooldownData {
         this.commandType = data.commandType;
     }
 
+    /**
+     * Check if the cooldown has ended.
+     */
     public isEnded(): boolean {
         return this.endsAt.getTime() <= Date.now();
     }

packages/core/src/classes/structures/MessageCommandOptionValue.ts

@@ -3,11 +3,29 @@ import { RecipleClient } from './RecipleClient.js';
 import { Message } from 'discord.js';
 
 export interface MessageCommandOptionValueData<T extends any = any> {
+    /**
+     * The name of the option.
+     */
     name: string;
+    /**
+     * The builder that is used to create the option.
+     */
     option: MessageCommandOptionBuilder<T>;
+    /**
+     * The raw value of the option.
+     */
     value: string|null;
+    /**
+     * Whether the option is missing.
+     */
     missing: boolean;
+    /**
+     * Whether the option is invalid.
+     */
     invalid: boolean;
+    /**
+     * The error that occurred while parsing the option.
+     */
     error?: string|Error;
 }
 
@@ -39,6 +57,10 @@ export class MessageCommandOptionValue<T extends any = any> implements MessageCo
         this.error = typeof options.error === 'string' ? new Error(options.error) : options.error;
     }
 
+    /**
+     * Resolves the raw value of the option.
+     * @param required Whether the option is required.
+     */
     public async resolveValue(required?: boolean): Promise<T|null>;
     public async resolveValue(required?: true): Promise<T>;
     public async resolveValue(required: boolean = false): Promise<T|null> {

packages/core/src/classes/structures/RecipleModule.ts

@@ -9,12 +9,37 @@ import { Utils } from './Utils.js';
 import semver from 'semver';
 
 export interface RecipleModuleData {
+    /**
+     * The id of your module.
+     * The id only accepts lowercase letters and cannot contain spaces or special characters.
+     */
     id?: string;
+    /**
+     * The name of your module. This is used to display when logging the module into the console.
+     */
     name?: string;
+    /**
+     * The supported reciple client versions of the module.
+     */
     versions?: string|string[];
+    /**
+     * The commands that the module will use.
+     */
     commands?: AnyCommandResolvable[];
+    /**
+     * The function that is executed when the module is resolved. (Bot's Pre-login)
+     * @param data The data that is passed to the module.
+     */
     onStart(data: RecipleModuleStartData): boolean|string|Error|Promise<boolean|string|Error>;
+    /**
+     * The function that is executed when the module is loaded. (Bot's Post-login)
+     * @param data The data that is passed to the module.
+     */
     onLoad?(data: RecipleModuleLoadData): void|string|Error|Promise<void|string|Error>;
+    /**
+     * The function that is executed when the module is unloaded. (Bot's Pre-logout)
+     * @param data The data that is passed to the module.
+     */
     onUnload?(data: RecipleModuleUnloadData): void|string|Error|Promise<void|string|Error>;
 }