Small utility library to replace circular references in JavaScript with JSONPaths
npm install json-cyclic
A small JavaScript library to replace circular references in object literals with JSONPath references, so that the data can be stringified as JSON.
It also supports re-inserting the circular data after the JSON has been parsed.
This will fix the below TypeErrors:
``
Chrome: "TypeError: Converting circular structure to JSON"
Firefox: "TypeError: cyclic object value"
Edge: "TypeError: Circular reference in value argument not supported"
Safari: "TypeError: JSON.stringify cannot serialize cyclic structures."
`
npm install json-cyclic
`js
// ES2015
import { encycle, decycle } from "json-cyclic"
// CommonJS
const JSONCyclic = require("json-cyclic")
`
There are only two methods exposed, and neither require any configuration:
See the below usage examples:
`js
// Arrays
const arr= [1, "a"]
arr[2] = arr;
JSON.stringify(decycle(arr)); // "{"foo":{"bar":{"$ref":"$.foo"}}}"
// Objects
const obj = { foo: { bar: null } };
obj.foo.bar = obj.foo;
JSON.stringify(decycle(obj)); // "{"foo":{"bar":{"$ref":"$.foo"}}}"
`
Re-inserts any circular data.
See the below:
`js
const arr = [1, "a", { $ref: "$" }]
encycle(arr)
console.log(arr[2] === arr) // true
JSON.stringify(encycle(arr)); // TypeError: Converting circular structure to JSON
`
`
npm test