destroy-circular

Replace circular references in an object with a string


Keywords
destroy, circular, references, replace, string
License
MIT
Install
npm install destroy-circular@1.1.0

Documentation

destroy circular

Creates a copy of an object where all of the circular references are replaced by a string [Circular]. Useful for protecting against problems when stringifying an object when you don't have control over the stringifying. If you can stringify the object yourself, I recommend using circular instead.

install

npm install destroy-circular

usage

var dc = require('destroy-circular');
var obj = {}; var child = {parent: obj}; obj.child = child;
var stringifySafeObj = dc(obj);
console.log(stringifySafeObj); // -> { child: { parent: '[Circular]' } }

The returned object is a copy—the original is not mutated in any way.

license

MIT