json-stringify-safe
    Overview
    Documentation
    Tutorials
    Chat
    Insights
    Code
    Dependencies
    Contributors
    Jobs

json-stringify-safe

Like JSON.stringify, but doesn't blow up on circular refs.

5.0.1  •  Updated 2 years ago  •  by Andri Möll  •  ISC License

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.

Popularity

Maintenance

Development

Last ver 5 years ago
Created 7 years ago
Last commit 5 years ago
1 month between commits

Technology

Node version: 2.0.1
0 unpacked

Compliance

ISC License
OSI Approved
0 vulnerabilities

Contributors

3 contributors
Andri Möll
Maintainer, 15 commits
Works at Monday Calendar
isaacs
Maintainer, 14 commits
Works at npm, Inc.
Mikeal Rogers
1 commits, 1 PRs
Works at Protocol Labs
matteofigus
1 PRs
Marsup
3 PRs
greenkeeperio-bot
5 PRs

Tags

json
stringify
circular
safe
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.