Renamed "safeSerialize" to "serializeToString" and added inline comment

facebook · Dec 18, 2019 · 80931fb · 80931fb
1 parent 7589f9e
commit 80931fb
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/react-devtools-shared/src/backend/utils.js b/packages/react-devtools-shared/src/backend/utils.js
@@ -39,7 +39,7 @@ export function cleanForBridge(
 }
 
 export function copyToClipboard(value: any): void {
-  const safeToCopy = safeSerialize(value);
+  const safeToCopy = serializeToString(value);
   copy(safeToCopy === undefined ? 'undefined' : safeToCopy);
 }
 
@@ -59,8 +59,9 @@ export function copyWithSet(
   return updated;
 }
 
-export function safeSerialize(data: any): string {
+export function serializeToString(data: any): string {
   const cache = new Set();
+  // Use a custom replacer function to protect against circular references.
   return JSON.stringify(data, (key, value) => {
     if (typeof value === 'object' && value !== null) {
       if (cache.has(value)) {