docs: Add JSDoc documentation to uuid.ts

madjin · Dec 29, 2024 · 3b33f2f · 3b33f2f
1 parent 9134d3c
commit 3b33f2f
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/core/src/uuid.ts b/packages/core/src/uuid.ts
@@ -1,6 +1,13 @@
 import { sha1 } from "js-sha1";
 import { UUID } from "./types.ts";
 
+/**
+ * Converts a string or number to a UUID.
+ *
+ * @param {string | number} target - The string or number to convert to a UUID.
+ * @throws {TypeError} If the value is not a string.
+ * @returns {UUID} The converted UUID.
+ */
 export function stringToUuid(target: string | number): UUID {
     if (typeof target === "number") {
         target = (target as number).toString();