json-stringify-safe
Like JSON.stringify, but doesn't blow up on circular refs.
Last updated 4 years ago by isaacs .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install json-stringify-safe 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 5.0.1                                ...           latest (4 years ago)

5 Versions

  • 5.0.1                                ...           4 years ago
  • 5.0.0                                ...           6 years ago
  • 4.0.0                                ...           7 years ago
  • 3.0.0                                ...           7 years ago
  • 2.0.0                                ...           7 years ago
Maintainers (2)
Downloads
Today 603
This Week 603
This Month 308,940
Last Day 7,528
Last Week 132,531
Last Month 542,207
Dependencies (0)
None
Dev Dependencies (3)
Dependents (1051)

Copyright 2014 - 2016 © taobao.org |