summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md')
-rw-r--r--deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md b/deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md
new file mode 100644
index 0000000000..c0537a9c3f
--- /dev/null
+++ b/deps/npm/node_modules/request/node_modules/json-stringify-safe/README.md
@@ -0,0 +1,27 @@
+# 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]"
+ ]
+}
+```