Add JSDoc

hugoalh · Jan 25, 2025 · 7c12c81 · 7c12c81
1 parent c22bb12
commit 7c12c81
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/mod.ts b/mod.ts
@@ -73,7 +73,17 @@ export interface URLRegExpOptions {
 	 */
 	trailingPeriod?: boolean;
 }
+/**
+ * Get the regular expression for the URLs.
+ * @param {URLRegExpOptions & { returnString?: false; }} [options={}] Options.
+ * @returns {RegExp}
+ */
 export function urlRegExp(options?: URLRegExpOptions & { returnString?: false; }): RegExp;
+/**
+ * Get the regular expression source string for the URLs.
+ * @param {URLRegExpOptions & { returnString: true; }} options Options.
+ * @returns {string}
+ */
 export function urlRegExp(options: URLRegExpOptions & { returnString: true; }): string;
 export function urlRegExp(options: URLRegExpOptions = {}): string | RegExp {
 	const {