BackPup/node
1
0 Fork 0
mirror of https://github.com/nodejs/node.git synced 2026-11-09 15:11:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

correct documentation of Stream#destroy

Browse Source
This commit is contained in:
Dominic Tarr authored and isaacs committed 2012-07-07 09:51:00 -07:00
1 parent 8a9e8d60d2
commit 7accaeb490
1 file changed
+3 -2
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/stream.markdown
+3 -2
View File
@@ -174,8 +174,9 @@ Same as above but with a `buffer`.
### stream.destroy()
Closes the underlying file descriptor. Stream will not emit any more events.
Any queued write data will not be sent.
Closes the underlying file descriptor. Stream is no longer `writable` nor `readable`.
the stream will not emit any more 'data', or 'end' events. Any queued write data will not be sent.
the stream should emit 'close' event once it's resources have been disposed of.
### stream.destroySoon()