JSPM

destroy-circular

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 844
  • Score
    100M100P100Q106126F
  • License MIT

Replace circular references in an object with a string

Package Exports

  • destroy-circular

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (destroy-circular) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

destroy circular

Creates a copy of an object where all of the circular references are replaced by a string [Circular]. Useful for protecting against problems when stringifying an object when you don't have control over the stringifying. If you can stringify the object yourself, I recommend using circular instead.

install

npm install destroy-circular

usage

var dc = require('destroy-circular');
var obj = {}; var child = {parent: obj}; obj.child = child;
var stringifySafeObj = dc(obj);
console.log(stringifySafeObj); // -> { child: { parent: '[Circular]' } }

The returned object is a copy—the original is not mutated in any way.

license

MIT