document autoDestroy

dominictarr · Apr 13, 2013 · c4520e5 · c4520e5
1 parent 1cabed2
commit c4520e5
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/readme.markdown b/readme.markdown
@@ -38,6 +38,26 @@ through(function write(data) {
   })
 ```
 
+## Extended Options
+
+You will probably not need these 99% of the time.
+
+### autoDestroy=false
+
+By default, `through` emits close when the writable
+and readable side of the stream has ended.
+If that is not desired, set `autoDestroy=false`.
+
+``` js
+var through = require('through')
+
+//like this
+var ts = through(write, end, {autoDestroy: false})
+//or like this
+var ts = through(write, end)
+ts.autoDestroy = false
+```
+
 ## License
 
 MIT / Apache2