You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
1002 B
Markdown
37 lines
1002 B
Markdown
7 months ago
|
# Circular
|
||
|
|
|
||
|
|
Tiny utility to safely stringify objects with circular references.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Replace all circular references with the string `[Circular]`;
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var circular = require('circular');
|
||
|
|
var obj = {}; var child = {parent: obj}; obj.child = child;
|
||
|
|
var str = JSON.stringify(obj, circular());
|
||
|
|
// => {"child":{"parent":"[Circular]"}}
|
||
|
|
```
|
||
|
|
|
||
|
|
If you prefer you can pass an alternative string to use:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var str = JSON.stringify(obj, circular('#ref'));
|
||
|
|
```
|
||
|
|
|
||
|
|
Or a function that returns a string:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
function ref(value){return '' + value};
|
||
|
|
var str = JSON.stringify(obj, circular(ref));
|
||
|
|
```
|
||
|
|
As of version `1.0.4` you can also pass an additional boolean that will convert function references to strings, useful for converting javascript modules to `couchdb` design documents.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var str = JSON.stringify(obj, circular(null, true));
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Everything is [MIT](http://en.wikipedia.org/wiki/MIT_License). Read the [license](/LICENSE) if you feel inclined.
|