added docs

rgrannell1 · Jul 15, 2023 · 023f455 · 023f455
1 parent 1295a3b
commit 023f455
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/string/string.ts b/src/string/string.ts
@@ -165,6 +165,13 @@ type UnicodeCategoryData = {
   category: string;
 };
 
+/*
+ * fromCharCode fails for code-points above 0xFFFF
+ *
+ * @param codePt A code-point
+ *
+ * @returns A string representation of the code-point
+ */
 function fixedFromCharCode (codePt: number) {
   if (codePt > 0xFFFF) {
       codePt -= 0x10000;