Socket
Socket
Sign inDemoInstall

json-stringify-safe

Package Overview
Dependencies
0
Maintainers
2
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

json-stringify-safe

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

    5.0.1latest
    GitHub
    npm

Version published
Maintainers
2
Weekly downloads
18,638,698
decreased by-13.88%

Weekly downloads

Package description

What is json-stringify-safe?

The json-stringify-safe package is a JSON serialization library that can stringify objects with circular references without throwing an error. It is particularly useful when dealing with complex objects where standard JSON.stringify() would fail due to circularity.

What are json-stringify-safe's main functionalities?

Stringify with circular references

This feature allows you to serialize objects that contain circular references by replacing the circular reference with a placeholder string that indicates the path of the circularity.

{"str": "Circular reference example", "obj": {"a": "b", "c": {"d": "[Circular ~.obj]"}}}

Custom replacer function

json-stringify-safe allows you to specify a custom replacer function to selectively serialize object properties, similar to the second argument of JSON.stringify().

{"str": "Custom replacer example", "obj": {"a": "b", "c": "[Filtered]"}}

Custom indentation

The package also supports custom indentation for the output string, allowing for more readable serialized JSON if needed.

{
  "str": "Indented output example",
  "obj": {
    "a": "b",
    "c": "d"
  }
}

Other packages similar to json-stringify-safe

Changelog

Source

5.0.1 (May 19, 2015)

  • Fixes stringify to only take ancestors into account when checking circularity.
    It previously assumed every visited object was circular which led to [false positives][issue9].
    Uses the tiny serializer I wrote for [Must.js][must] a year and a half ago.
  • Fixes calling the replacer function in the proper context (thisArg).
  • Fixes calling the cycleReplacer function in the proper context (thisArg).
  • Speeds serializing by a factor of Big-O(h-my-god-it-linearly-searched-every-object) it had ever seen. Searching only the ancestors for a circular references speeds up things considerably.

Readme

Source

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.

Keywords

FAQs

Last updated on 19 May 2015

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc