flatted
Advanced tools
Package description
The flatted npm package is a library for encoding and decoding JavaScript objects into a flat JSON format. It is particularly useful for handling circular references and complex data structures that JSON.stringify cannot handle by default.
Encoding objects with circular references
Flatted allows you to encode objects that have circular references, which would throw an error with JSON.stringify. For example, if you have an object 'circularObj' that references itself, you can use flatted.stringify(circularObj) to get a string representation of the object.
{"encoded": "flatted.stringify(circularObj)"}Decoding flatted strings back to objects
After encoding an object with circular references using flatted, you can decode the resulting string back into an object with flatted.parse(flattedString). This will restore the circular references and give you back the original object structure.
{"decoded": "flatted.parse(flattedString)"}CircularJSON is a JSON-like format that can encode circular structures and other complex data types. It is similar to flatted but was superseded by flatted due to its ability to handle more data types and its smaller footprint.
json-stringify-safe is a package that can stringify objects with circular references without throwing. It works by replacing circular references with a string '[Circular]'. It is similar to flatted but does not allow for reconstruction of the original object with circular references.
Readme
A super light (0.5K) and fast circular JSON parser, directly from the creator of CircularJSON.
Usable via CDN or as regular module.
// ESM
import {parse, stringify} from 'flatted/esm';
// CJS
const {parse, stringify} = require('flatted/cjs');
const a = [{}];
a[0].a = a;
a.push(a);
stringify(a); // [["1","0"],{"a":"0"}]
.parse(string, reviver) and revive your own objects.space parameter to .stringify(object, replacer, space) for feature parity with JSON signature.All ECMAScript engines compatible with Map, Set, Object.keys, and Array.prototype.reduce will work, even if polyfilled.
While stringifying, all Objects, including Arrays, and strings, are flattened out and replaced as unique index. *
Once parsed, all indexes will be replaced through the flattened collection.
* represented as string to avoid conflicts with numbers
// logic example
var a = [{one: 1}, {two: '2'}];
a[0].a = a;
// a is the main object, will be at index '0'
// {one: 1} is the second object, index '1'
// {two: '2'} the third, in '2', and it has a string
// which will be found at index '3'
Flatted.stringify(a);
// [["1","2"],{"one":1,"a":"0"},{"two":"3"},"2"]
// a[one,two] {one: 1, a} {two: '2'} '2'
FAQs
A super light and fast circular JSON parser.
We found that flatted demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.