From 44da16bbc6417d694108126a5c41faffe1444958 Mon Sep 17 00:00:00 2001
From: Cat++ <69035887+NotGhex@users.noreply.github.com>
Date: Sat, 9 Dec 2023 09:38:05 +0800
Subject: [PATCH] document idk

---
 packages/utils/src/classes/MessageURLData.ts | 61 ++++++++++++++++++++
 packages/utils/src/helpers/mentions.ts       |  1 -
 2 files changed, 61 insertions(+), 1 deletion(-)

diff --git a/packages/utils/src/classes/MessageURLData.ts b/packages/utils/src/classes/MessageURLData.ts
index ff659d38..a7fe6f19 100644
--- a/packages/utils/src/classes/MessageURLData.ts
+++ b/packages/utils/src/classes/MessageURLData.ts
@@ -1,23 +1,50 @@
 import { BaseFetchOptions, Client, DMChannel, Guild, GuildTextBasedChannel, If, Message, PartialDMChannel, PartialGroupDMChannel, TextBasedChannel } from 'discord.js';
 
+/**
+ * Message URL parse data
+ */
 export interface ParseMessageURLData {
     guildId: string|null;
     channelId: string;
     messageId: string;
 }
 
+/**
+ * Message URL object
+ */
 export class MessageURLData<InGuild extends boolean = boolean, Fetched extends boolean = boolean> implements ParseMessageURLData {
     private _guildId: string|null = null;
     private _guild?: Guild|null;
     private _channel?: TextBasedChannel|null;
     private _message?: Message|null;
 
+    /**
+     * The message channel id
+     */
     readonly channelId: string;
+    /**
+     * The message id
+     */
     readonly messageId: string;
 
+    /**
+     * The message guild id
+     */
     get guildId() { return this._guildId as If<InGuild, string>; }
+
+    /**
+     * The message guild object
+     */
     get guild() { return this._guild as If<Fetched, If<InGuild, Guild, null>, undefined>; }
+
+    /**
+     * THe message channel object
+     */
     get channel() { return this._channel as If<Fetched, If<InGuild, GuildTextBasedChannel, PartialGroupDMChannel|DMChannel|PartialDMChannel>, undefined>; }
+
+    /**
+     * The message object
+     */
     get message() { return this._message as If<Fetched, Message<InGuild>, undefined>; }
 
     constructor(data: ParseMessageURLData, public client?: Client) {
@@ -26,6 +53,10 @@ export class MessageURLData<InGuild extends boolean = boolean, Fetched extends b
         this.messageId = data.messageId;
     }
 
+    /**
+     * Fetch guild, channel, and message objects
+     * @param options Fetch options
+     */
     public async fetch(options?: BaseFetchOptions & { client?: Client }): Promise<MessageURLData<InGuild, true>> {
         this.client = options?.client ?? this.client;
         if (!this.client) throw new Error('Discord.js client is not defined');
@@ -39,22 +70,37 @@ export class MessageURLData<InGuild extends boolean = boolean, Fetched extends b
         return this as MessageURLData<InGuild, true>;
     }
 
+    /**
+     * Check if the objects are fetched
+     */
     public isFetched(): this is MessageURLData<InGuild, true> {
         return this._guild !== undefined && this._channel !== undefined && this._message !== undefined;
     }
 
+    /**
+     * Check if message URL is in DM
+     */
     public isDMBased(): this is MessageURLData<false, Fetched> {
         return this.guildId === null;
     }
 
+    /**
+     * Check if message URL is in guild
+     */
     public inGuild(): this is MessageURLData<true, Fetched> {
         return !this.isDMBased();
     }
 
+    /**
+     * Get URL string
+     */
     public toString(): string {
         return `https://discord.com/channels/${this.guildId ?? '@me'}/${this.channelId}/${this.messageId}`;
     }
 
+    /**
+     * Flatten object data
+     */
     public toJSON(): ParseMessageURLData {
         return {
             guildId: this.guildId,
@@ -63,11 +109,22 @@ export class MessageURLData<InGuild extends boolean = boolean, Fetched extends b
         };
     }
 
+    /**
+     * Fetch message URL data
+     * @param url The message URL
+     * @param client Discord.js client object
+     * @param fetchOptions Fetch options
+     */
     public static async fetch<InGuild extends boolean = boolean>(url: string|URL, client: Client, fetchOptions?: BaseFetchOptions): Promise<MessageURLData<InGuild, true>> {
         const data = this.parse<InGuild>(url);
         return data.fetch({ ...fetchOptions, client });
     }
 
+    /**
+     * Parse message URL data without fetching objects
+     * @param url The message URL
+     * @param client Discord.js client object
+     */
     public static parse<InGuild extends boolean = boolean>(url: string|URL, client?: Client): MessageURLData<InGuild, false> {
         const structure = url instanceof URL ? url : new URL(url);
         const path = structure.pathname.split('/').filter(Boolean);
@@ -84,6 +141,10 @@ export class MessageURLData<InGuild extends boolean = boolean, Fetched extends b
         }, client);
     }
 
+    /**
+     * Check if string is valid message URL
+     * @param url url string
+     */
     public static isValidMessageURL(url: string|URL): boolean {
         try {
             const structure = url instanceof URL ? url : new URL(url);
diff --git a/packages/utils/src/helpers/mentions.ts b/packages/utils/src/helpers/mentions.ts
index 1272b8f6..477227b6 100644
--- a/packages/utils/src/helpers/mentions.ts
+++ b/packages/utils/src/helpers/mentions.ts
@@ -12,7 +12,6 @@ export interface FetchMentionOrIdOptions {
 /**
  * Get user id from mention or user object
  * @param user User resolvable
- * @returns 
  */
 export function getMentionId(user: UserResolvable|APIUser|APIMessage|`<@${string}>`): string|null {
     const id = typeof user === 'string'