source: trip-planner-front/node_modules/flatted/README.md@ 76712b2

Last change on this file since 76712b2 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 2.9 KB
Line 
1# flatted
2
3![Downloads](https://img.shields.io/npm/dm/flatted.svg) [![Coverage Status](https://coveralls.io/repos/github/WebReflection/flatted/badge.svg?branch=master)](https://coveralls.io/github/WebReflection/flatted?branch=master) [![Build Status](https://travis-ci.org/WebReflection/flatted.svg?branch=master)](https://travis-ci.org/WebReflection/flatted) [![License: ISC](https://img.shields.io/badge/License-ISC-yellow.svg)](https://opensource.org/licenses/ISC) ![WebReflection status](https://offline.report/status/webreflection.svg)
4
5A 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
8npm i flatted
9```
10
11Usable via [CDN](https://unpkg.com/flatted) or as regular module.
12
13```js
14// ESM
15import {parse, stringify} from 'flatted/esm';
16
17// CJS
18const {parse, stringify} = require('flatted/cjs');
19
20const a = [{}];
21a[0].a = a;
22a.push(a);
23
24stringify(a); // [["1","0"],{"a":"0"}]
25```
26
27## Flatted VS JSON
28
29As 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
31The 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
33Also 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
43All ECMAScript engines compatible with `Map`, `Set`, `Object.keys`, and `Array.prototype.reduce` will work, even if polyfilled.
44
45
46### How does it work ?
47While stringifying, all Objects, including Arrays, and strings, are flattened out and replaced as unique index. `*`
48
49Once 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
55var a = [{one: 1}, {two: '2'}];
56a[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
62Flatted.stringify(a);
63// [["1","2"],{"one":1,"a":"0"},{"two":"3"},"2"]
64// a[one,two] {one: 1, a} {two: '2'} '2'
65```
Note: See TracBrowser for help on using the repository browser.