📚 deepFreeze に JSDoc 書く

traPtitech · Nov 4, 2023 · 3a8762c · 3a8762c
1 parent 63ef27f
commit 3a8762c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/lib/deepFreeze.ts b/src/lib/deepFreeze.ts
@@ -1,3 +1,10 @@
+/**
+ * オブジェクトや配列の全てのプロパティを再帰的にfreezeする
+ *
+ * 自己参照など閉路が存在する場合は無限ループに陥るので注意
+ *
+ * @see https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze
+ */
 export const deepFreeze = <const T extends object>(obj: T): T => {
   const propNames = Object.getOwnPropertyNames(obj)