Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation/Add 'close' events to fs.ReadStream, fs.WriteStream, etc per Issue #6484 #6499

Closed
wants to merge 8 commits into from
Closed

Documentation/Add 'close' events to fs.ReadStream, fs.WriteStream, etc per Issue #6484 #6499

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9d48b5d
Add 'close' events to fs.ReadStream and fs.WriteSTream
May 1, 2016
ff217a8
Add 'close' event to stream.Writable per Issue #6484
May 1, 2016
827dfcb
Add #### prefix to Event: 'close' and backticks to 'close' similar to…
May 1, 2016
57aa9e6
Add more specifics to 'close' events for fs.ReadStream and fs.WriteSt…
May 1, 2016
439df4b
Fix/Changed 'close' event from 'fs.ReadStream' to 'fs.WriteStream'
May 1, 2016
b2a0db1
wrapped long lines at 80 chars, reworded
May 2, 2016
bcc8bd2
including the 'close' event as optional
May 2, 2016
8cdf720
add 'close' event as optional in stream.Readable
May 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix/Changed 'close' event from 'fs.ReadStream' to 'fs.WriteStream'
  • Loading branch information
Jenna Vuong committed May 1, 2016
commit 439df4bc52d923b1daa3d8877b5f61a9f8dc94e7
2 changes: 1 addition & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Emitted when the WriteStream's file is opened.

### Event: 'close'

Emitted when the ReadStream's underlying file descriptor has been closed. Comes from fs.close() method.
Emitted when the WriteStream's underlying file descriptor has been closed. Comes from fs.close() method.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nodejs/streams can we please check this? I thought 'close' was for Readable and 'finish' was for 'Writable'. However, in 'fs' we have 'close' for 'Writable' as well. I do not think custom stream events are that helpful in understanding, so maybe we might want to rationalize this (or document it in streams).


### writeStream.bytesWritten

Expand Down