Need help with json-stringify-safe?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

moll
500 Stars 47 Forks ISC License 30 Commits 7 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

# 141,649
Ruby
Vim
testing...
Shell
15 commits
# 170
C++
node
code-co...
Express
14 commits
# 6,967
JavaScr...
pouchdb
D
ipld
1 commit

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.