Add comment

getsentry · May 25, 2022 · 4429b64 · 4429b64
1 parent 75373c1
commit 4429b64
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/utils/src/object.ts b/packages/utils/src/object.ts
@@ -206,6 +206,8 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
 /**
  * Given any object, return the new object with removed keys that value was `undefined`.
  * Works recursively on objects and arrays.
+ *
+ * Attention: This function keeps circular references in the returned object.
  */
 export function dropUndefinedKeys<T>(val: T): T {
   // This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API