Question 1

How to handle circular references in JSON.stringify?

Accepted Answer

Use CircularJSON.stringify() to serialize objects with circular references, preserving them in a custom format. Deserialize with CircularJSON.parse() to restore the original structure, avoiding errors from native JSON methods.

Question 2

CircularJSON vs json-stringify-safe: which one should I use?

Accepted Answer

Choose CircularJSON if you need to deserialize circular references back to objects, as it preserves structural integrity. json-stringify-safe is better for logging only, as it replaces references with '[Circular]' and cannot restore them, as explained in the README comparison.

Question 3

How to migrate from CircularJSON to flatted?

Accepted Answer

Replace CircularJSON with flatted in your imports, as flatted uses the same API but is smaller and faster. Update any serialized data, as flatted might produce different output, but it handles circular references similarly for backward compatibility.

Question 4

Does CircularJSON work with TypeScript?

Accepted Answer

Yes, CircularJSON can be used with TypeScript via npm installation, but you may need to add type definitions manually or use community packages, as the library itself doesn't provide built-in TypeScript support.

Question 5

What does the output of CircularJSON look like?

Accepted Answer

Output uses `~` prefixes to indicate reference paths, e.g., '{"arr":["~","~","~arr"],"obj":"~"}' for circular objects. This compact format reduces size but requires CircularJSON to parse correctly.

Question 6

Can I use CircularJSON in the browser?

Accepted Answer

Yes, CircularJSON supports browsers via script tags or module systems, as detailed in the installation section. However, ensure JSON is available natively or use a polyfill for older environments like IE8.

CircularJSON

What is CircularJSON?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions