| 1 | # flatted
|
|---|
| 2 |
|
|---|
| 3 |  [](https://coveralls.io/github/WebReflection/flatted?branch=master) [](https://travis-ci.org/WebReflection/flatted) [](https://opensource.org/licenses/ISC) 
|
|---|
| 4 |
|
|---|
| 5 | A super light (0.5K) and fast circular JSON parser, directly from the creator of [CircularJSON](https://github.com/WebReflection/circular-json/#circularjson).
|
|---|
| 6 |
|
|---|
| 7 | ```js
|
|---|
| 8 | npm i flatted
|
|---|
| 9 | ```
|
|---|
| 10 |
|
|---|
| 11 | Usable via [CDN](https://unpkg.com/flatted) or as regular module.
|
|---|
| 12 |
|
|---|
| 13 | ```js
|
|---|
| 14 | // ESM
|
|---|
| 15 | import {parse, stringify} from 'flatted/esm';
|
|---|
| 16 |
|
|---|
| 17 | // CJS
|
|---|
| 18 | const {parse, stringify} = require('flatted/cjs');
|
|---|
| 19 |
|
|---|
| 20 | const a = [{}];
|
|---|
| 21 | a[0].a = a;
|
|---|
| 22 | a.push(a);
|
|---|
| 23 |
|
|---|
| 24 | stringify(a); // [["1","0"],{"a":"0"}]
|
|---|
| 25 | ```
|
|---|
| 26 |
|
|---|
| 27 | ## Flatted VS JSON
|
|---|
| 28 |
|
|---|
| 29 | As it is for every other specialized format capable of serializing and deserializing circular data, you should never `JSON.parse(Flatted.stringify(data))`, and you should never `Flatted.parse(JSON.stringify(data))`.
|
|---|
| 30 |
|
|---|
| 31 | The only way this could work is to `Flatted.parse(Flatted.stringify(data))`, as it is also for _CircularJSON_ or any other, otherwise there's no granted data integrity.
|
|---|
| 32 |
|
|---|
| 33 | Also please note this project serializes and deserializes only data compatible with JSON, so that sockets, or anything else with internal classes different from those allowed by JSON standard, won't be serialized and unserialized as expected.
|
|---|
| 34 |
|
|---|
| 35 |
|
|---|
| 36 | ### New in V1: Exact same JSON API
|
|---|
| 37 |
|
|---|
| 38 | * Added a [reviver](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Syntax) parameter to `.parse(string, reviver)` and revive your own objects.
|
|---|
| 39 | * Added a [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Syntax) and a `space` parameter to `.stringify(object, replacer, space)` for feature parity with JSON signature.
|
|---|
| 40 |
|
|---|
| 41 |
|
|---|
| 42 | ### Compatibility
|
|---|
| 43 | All ECMAScript engines compatible with `Map`, `Set`, `Object.keys`, and `Array.prototype.reduce` will work, even if polyfilled.
|
|---|
| 44 |
|
|---|
| 45 |
|
|---|
| 46 | ### How does it work ?
|
|---|
| 47 | While stringifying, all Objects, including Arrays, and strings, are flattened out and replaced as unique index. `*`
|
|---|
| 48 |
|
|---|
| 49 | Once parsed, all indexes will be replaced through the flattened collection.
|
|---|
| 50 |
|
|---|
| 51 | <sup><sub>`*` represented as string to avoid conflicts with numbers</sub></sup>
|
|---|
| 52 |
|
|---|
| 53 | ```js
|
|---|
| 54 | // logic example
|
|---|
| 55 | var a = [{one: 1}, {two: '2'}];
|
|---|
| 56 | a[0].a = a;
|
|---|
| 57 | // a is the main object, will be at index '0'
|
|---|
| 58 | // {one: 1} is the second object, index '1'
|
|---|
| 59 | // {two: '2'} the third, in '2', and it has a string
|
|---|
| 60 | // which will be found at index '3'
|
|---|
| 61 |
|
|---|
| 62 | Flatted.stringify(a);
|
|---|
| 63 | // [["1","2"],{"one":1,"a":"0"},{"two":"3"},"2"]
|
|---|
| 64 | // a[one,two] {one: 1, a} {two: '2'} '2'
|
|---|
| 65 | ```
|
|---|
