Like JSON.stringify, but doesn't throw on circular references.

Takes the same arguments as JSON.stringify.

var stringify = require('json-stringify-safe');
var circularObj = {};
circularObj.circularRef = circularObj;
circularObj.list = [ circularObj, circularObj ];
console.log(stringify(circularObj, null, 2));

Output:

{
  "circularRef": "[Circular ~]",
  "list": [
    "[Circular ~]",
    "[Circular ~]"
  ]
}

stringify(obj, serializer, indent, decycler)

The first three arguments are the same as to JSON.stringify. The last is an argument that's only used when the object has been seen already.

The default decycler function returns a string like '[Circular ~.a.b]' where ~.a.b represents where the circular reference comes from (~ being the stringified object). If, for example, you pass an empty function (k,v) => {} then it will prune cycles. If you pass in (k,v) => ({ foo: 'bar' }), then cyclical objects will always be represented as {"foo":"bar"} in the result. If you pass () => '[Circular]', then every circular reference will be just [Circular] without the ~-path.

stringify.getSerialize(serializer, decycler)

Returns a serializer that can be used elsewhere. This is the actual function that's passed to JSON.stringify.

Note that the function returned from getSerialize is stateful for now, so do not use it more than once.