chore: add comment for getTsid()

yubinTW · Nov 28, 2023 · 0c851ea · 0c851ea
1 parent 4f66658
commit 0c851ea
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/tsid.ts b/src/tsid.ts
@@ -30,6 +30,10 @@ _setAlphabetValues('l', 1)
 
 type StringFormat = 's' | 'S' | 'x' | 'X' | 'd' | 'z'
 
+/**
+ * Returns a new TSID.
+ * @returns TSID
+ */
 export const getTsid: () => TSID = () => TSID.create()
 
 export class TSID {