Like JSON.stringify, but doesn't throw on circular references
Clone or download
Latest commit 5930d6e May 20, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test Call replacer for root object. Mar 3, 2015
.gitignore Add .npmignore and .gitignore. Mar 3, 2015
.npmignore Add .npmignore and .gitignore. Mar 3, 2015
CHANGELOG.md Update CHANGELOG. May 20, 2015
LICENSE isc license May 19, 2015
Makefile Add Makefile. Mar 3, 2015
README.md Make a note about the statefulness of the serializer. Mar 3, 2015
package.json Update test script. May 20, 2015
stringify.js Inline pathize. Mar 3, 2015

README.md

json-stringify-safe

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

Usage

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]"
  ]
}

Details

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 the string '[Circular]'. If, for example, you pass in function(k,v){} (return nothing) then it will prune cycles. If you pass in function(k,v){ return {foo: 'bar'}}, then cyclical objects will always be represented as {"foo":"bar"} in the result.

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.