setup-kubectl/node_modules/json-stringify-safe
github-actions[bot] 7f7e5ba5ea
Add node modules and compiled JavaScript from main (#57)
Co-authored-by: Oliver King <oking3@uncc.edu>
2022-06-21 12:18:30 -04:00
..
test Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
.npmignore Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
CHANGELOG.md Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
LICENSE Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
Makefile Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
package.json Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
README.md Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00
stringify.js Add node modules and compiled JavaScript from main (#57) 2022-06-21 12:18:30 -04:00

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.