Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WebReflection/circular-json
JSON does not handle circular references. Now it does
https://github.com/WebReflection/circular-json
Last synced: about 2 months ago
JSON representation
JSON does not handle circular references. Now it does
- Host: GitHub
- URL: https://github.com/WebReflection/circular-json
- Owner: WebReflection
- License: mit
- Archived: true
- Created: 2013-03-13T14:48:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-05-27T19:08:01.000Z (over 5 years ago)
- Last Synced: 2024-04-16T00:42:53.391Z (5 months ago)
- Language: JavaScript
- Size: 2.01 MB
- Stars: 601
- Watchers: 19
- Forks: 93
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
CircularJSON
============
[](https://github.com/WebReflection/donate)  [](https://travis-ci.org/WebReflection/circular-json) [](https://coveralls.io/github/WebReflection/circular-json?branch=master)
Serializes and deserializes otherwise valid JSON objects containing circular references into and from a specialized JSON format.
- - -
## The future of this module is called [flatted](https://github.com/WebReflection/flatted#flatted)
Smaller, faster, and able to produce on average a reduced output too, [flatted](https://github.com/WebReflection/flatted#flatted) is the new, bloatless, ESM and CJS compatible, circular JSON parser.
It has now reached V1 and it implements the exact same JSON API.
Please note **CircularJSON is in maintenance only** and **[flatted](https://github.com/WebReflection/flatted#flatted) is its successor**.
- - -
### A Working Solution To A Common Problem
A usage example:
```JavaScript
var object = {};
object.arr = [
object, object
];
object.arr.push(object.arr);
object.obj = object;
var serialized = CircularJSON.stringify(object);
// '{"arr":["~","~","~arr"],"obj":"~"}'
// NOTE: CircularJSON DOES NOT parse JS
// it handles receiver and reviver callbacks
var unserialized = CircularJSON.parse(serialized);
// { arr: [ [Circular], [Circular] ],
// obj: [Circular] }
unserialized.obj === unserialized;
unserialized.arr[0] === unserialized;
unserialized.arr.pop() === unserialized.arr;
```
A quick summary:
* **new** in version `0.5`, you can specify a JSON parser different from JSON itself. `CircularJSON.parser = ABetterJSON;` is all you need.
* uses `~` as a special prefix symbol to denote which parent the reference belongs to (i.e. `~root~child1~child2`)
* reasonably fast in both serialization and deserialization
* compact serialization for easier and slimmer transportation across environments
* [tested and covered](test/circular-json.js) over nasty structures too
* compatible with all JavaScript engines
Node Installation & Usage
============
```bash
npm install --save circular-json
```
```javascript
'use strict';
var
CircularJSON = require('circular-json'),
obj = { foo: 'bar' },
str
;
obj.self = obj;
str = CircularJSON.stringify(obj);
```
There are no dependencies.
Browser Installation & Usage
================
* Global:
* AMD:
* CommonJS:
(generated via [gitstrap](https://github.com/WebReflection/gitstrap))
```html
```
```javascript
'use strict';
var CircularJSON = window.CircularJSON
, obj = { foo: 'bar' }
, str
;
obj.self = obj;
str = CircularJSON.stringify(obj);
```
NOTE: Platforms without native JSON (i.e. MSIE <= 8) requires `json3.js` or similar.
It is also *a bad idea* to `CircularJSON.parse(JSON.stringify(object))` because of those manipulation used in `CircularJSON.stringify()` able to make parsing safe and secure.
As summary: `CircularJSON.parse(CircularJSON.stringify(object))` is the way to go, same is for `JSON.parse(JSON.stringify(object))`.
API
===
It's the same as native JSON, except the fourth parameter `placeholder`, which circular references to be replaced with `"[Circular]"` (i.e. for logging).
* CircularJSON.stringify(object, replacer, spacer, placeholder)
* CircularJSON.parse(string, reviver)
Bear in mind `JSON.parse(CircularJSON.stringify(object))` will work but not produce the expected output.
Similar Libraries
=======
### Why Not the [@izs](https://twitter.com/izs) One
The module [json-stringify-safe](https://github.com/isaacs/json-stringify-safe) seems to be for `console.log()` but it's completely pointless for `JSON.parse()`, being latter one unable to retrieve back the initial structure. Here an example:
```JavaScript
// a logged object with circular references
{
"circularRef": "[Circular]",
"list": [
"[Circular]",
"[Circular]"
]
}
// what do we do with above output ?
```
Just type this in your `node` console: `var o = {}; o.a = o; console.log(o);`. The output will be `{ a: [Circular] }` ... good, but that ain't really solving the problem.
However, if that's all you need, the function used to create that kind of output is probably faster than `CircularJSON` and surely fits in less lines of code.
### Why Not {{put random name}} Solution
So here the thing: circular references can be wrong but, if there is a need for them, any attempt to ignore them or remove them can be considered just a failure.
Not because the method is bad or it's not working, simply because the circular info, the one we needed and used in the first place, is lost!
In this case, `CircularJSON` does even more than just solve circular and recursions: it maps all same objects so that less memory is used as well on deserialization as less bandwidth too!
It's able to redefine those references back later on so the way we store is the way we retrieve and in a reasonably performant way, also trusting the snappy and native `JSON` methods to iterate.