circular-ref-fix

🎡 Fixes circular dependencies using $id identifiers and $ref pointers. Produces Json.NET friendly result.

---

Usage

Let's model Simpsons family (Maggie hasn't born yet),

    var child1 = {
        name: 'Bart'
    };
    var child2 = {
        name: 'Lisa'
    };
    var mother = {
        name: 'Marge'
    };
    var father = {
        name: 'Homer'
    };
 
    child1.siblings = [child2];
    child1.mother = mother;
    child1.father = father;
 
    child2.siblings = [child1];
    child2.mother = mother;
    child2.father = father;
 
    mother.spouse = father;
    mother.children = [child1, child2];
 
    father.spouse = mother;
    father.children = [child1, child2];
    
    JSON.stringify([mother, father]); // error! could not serialize

We create referential links between objects;

var circularFix = require('circular-ref-fix');
var createRefs = circularFix.createRefs;
 
var fixed = createRefs(couple);

Produces below object;

[  
   {  
      "$id":"1",
      "name":"Marge",
      "spouse":{  
         "$id":"2",
         "name":"Homer",
         "spouse":{  
            "$ref":"1"
         },
         "children":[  
            {  
               "$id":"3",
               "name":"Bart",
               "siblings":[  
                  {  
                     "$id":"4",
                     "name":"Lisa",
                     "siblings":[  
                        {  
                           "$ref":"3"
                        }
                     ],
                     "mother":{  
                        "$ref":"1"
                     },
                     "father":{  
                        "$ref":"2"
                     }
                  }
               ],
               "mother":{  
                  "$ref":"1"
               },
               "father":{  
                  "$ref":"2"
               }
            },
            {  
               "$ref":"4"
            }
         ]
      },
      "children":[  
         {  
            "$ref":"3"
         },
         {  
            "$ref":"4"
         }
      ]
   },
   {  
      "$ref":"2"
   }
]

Also, we can restore circular structure back;

var circularFix = require('circular-ref-fix');
var restored = restoreRefs(fixed, true); // with true option, we tell restoreRefs to delete $id fields

Json.NET can handle this structure too;

var settings = new JsonSerializerSettings {
    PreserveReferencesHandling = PreserveReferencesHandling.Objects
};
 
JsonConvert.DeserializeObject<List<Parent>>(fixedStr, settings);

---

Node installation and usage

npm i circular-ref-fix
 
var circularFix = require('circular-ref-fix');

---

Because we are using UMD pattern, you can use the circular-fix.js file on browser with script tag or Require.JS.