mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
Code Issues Releases Activity

correct documentation of Stream#destroy

Browse Source
This commit is contained in:
Dominic Tarr 2012-07-07 12:25:13 +12:00 committed by isaacs
parent 8a9e8d60d2
commit 7accaeb490
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/stream.markdown
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()