Permalink
Browse files

documented stringifyObject

  • Loading branch information...
1 parent f5cbab5 commit 4c6b5b16d49257e1ac73a9a4d2af58a4b40e2206 @substack committed Feb 22, 2012
Showing with 7 additions and 2 deletions.
  1. +5 −0 README.markdown
  2. +2 −2 package.json
View
5 README.markdown
@@ -37,6 +37,11 @@ available.
If there are multiple streams in `object`, the others will get paused and
buffered while waiting for each stream to finish.
+Streams are treated as arrays with new elements for every `'data'` event.
+To emit a streaming object using
+[JSONStream](https://github.com/dominictarr/JSONStream)
+`.stringifyStream()`, set `stream.type = 'object'`.
+
install
=======
View
4 package.json
@@ -1,7 +1,7 @@
{
"name" : "gutter",
"description" : "streaming JSON.stringify() for nested streams",
- "version" : "0.0.1",
+ "version" : "0.1.0",
"repository" : {
"type" : "git",
"url" : "git://github.com/substack/node-gutter.git"
@@ -26,7 +26,7 @@
"morestreams" : "0.1.x"
},
"devDependencies" : {
- "tap" : "0.0.x",
+ "tap" : "~0.2.1",
"event-stream" : "0.6.x"
},
"engines" : {

0 comments on commit 4c6b5b1

Please sign in to comment.