Course contentsShow
← JavaScript
Lesson 2411 of 2,72349. Common Patterns and IdiomsFree lesson

Circular Reference Detection

Using a WeakMap or Set to track visited objects and prevent infinite loops on circular structures.

Circular Reference Detection

You'll learn how to detect when objects reference each other in a loop, preventing infinite recursion in deep operations.

The Problem with Circular Structures

When you're recursively traversing objects (for deep cloning or deep equality), you can encounter circular references—objects that reference themselves directly or indirectly:

const obj = { name: "Alice" };
obj.self = obj; // obj.self.self.self... infinitely!

Without detection, your recursive function will loop forever, causing a stack overflow.

Using WeakSet to Track Visited Objects

A WeakSet is perfect for tracking which objects you've already visited. It holds object references without preventing garbage collection:

function deepClone(obj, visited = new WeakSet()) {
  // Check if we've seen this object before
  if (visited.has(obj)) {
    throw new Error("Circular reference detected");
    // or return a placeholder
  }
  
  visited.add(obj); // Mark as visited
  
  const clone = {};
  for (let key in obj) {
    if (typeof obj[key] === 'object' && obj[key] !== null) {
      clone[key] = deepClone(obj[key], visited);
    } else {
      clone[key] = obj[key];
    }
  }
  return clone;
}

Why WeakSet or WeakMap?

  • WeakSet holds object references that don't count for garbage collection
  • Perfect for temporary tracking during a single operation
  • Automatically cleans up when objects are no longer needed
  • You can also use WeakMap if you need to store additional data per object

The Pattern

  1. Create a WeakSet (or Set) before recursing
  2. Check has() before processing each object
  3. add() the object immediately after checking
  4. Pass the set through recursive calls

Key Takeaway: Use a WeakSet or Set to track visited objects during recursion, checking has() before processing to catch circular references and prevent infinite loops.