https://github.com/moll/json-stringify-safe

Like JSON.stringify, but doesn't throw on circular references
https://github.com/moll/json-stringify-safe

Last synced: 11 days ago
JSON representation

Like JSON.stringify, but doesn't throw on circular references

• Host: GitHub
• URL: https://github.com/moll/json-stringify-safe
• Owner: moll
• License: isc
• Created: 2013-02-19T19:01:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T15:46:34.000Z (3 months ago)
• Last Synced: 2024-09-10T07:19:47.612Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 31.3 KB
• Stars: 550
• Watchers: 17
• Forks: 51
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - json-stringify-safe
• awesome-nodejs - json-stringify-safe - Like JSON.stringify, but doesn't throw on circular references.  (Repository / Object / JSON / JSON Schema)
• awesome-github-star - json-stringify-safe

README

        
# json-stringify-safe

Like JSON.stringify, but doesn't throw on circular references.

## Usage

Takes the same arguments as `JSON.stringify`.

```javascript

var stringify = require('json-stringify-safe');

var circularObj = {};

circularObj.circularRef = circularObj;

circularObj.list = [ circularObj, circularObj ];

console.log(stringify(circularObj, null, 2));

```

Output:

```json

{

  "circularRef": "[Circular]",

  "list": [

    "[Circular]",

    "[Circular]"

  ]

}

```

## Details

```

stringify(obj, serializer, indent, decycler)

```

The first three arguments are the same as to JSON.stringify.  The last

is an argument that's only used when the object has been seen already.

The default `decycler` function returns the string `'[Circular]'`.

If, for example, you pass in `function(k,v){}` (return nothing) then it

will prune cycles.  If you pass in `function(k,v){ return {foo: 'bar'}}`,

then cyclical objects will always be represented as `{"foo":"bar"}` in

the result.

```

stringify.getSerialize(serializer, decycler)

```

Returns a serializer that can be used elsewhere.  This is the actual

function that's passed to JSON.stringify.

**Note** that the function returned from `getSerialize` is stateful for now, so

do **not** use it more than once.