Skip to content

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

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

Closed
jennabelle 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
Next Next commit
Add 'close' events to fs.ReadStream and fs.WriteSTream
  • Loading branch information
Jenna Vuong
Jenna Vuong committed May 1, 2016
commit 9d48b5dc549e6fa99f2060280b175f2d3909f546
8 changes: 8 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@ Stop watching for changes on the given `fs.FSWatcher`.

Emitted when the ReadStream's file is opened.

### Event: 'close'

Emitted when a ReadStream's file has ended or closed. Comes from fs.close() method.

@mscdex mscdex May 1, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe something more specific like "Emitted when the ReadStream's underlying file descriptor has been closed" and similarly for WriteStream?


### readStream.path

The path to the file the stream is reading from as specified in the first
Expand Down Expand Up @@ -238,6 +242,10 @@ on Unix systems, it never was.

Emitted when the WriteStream's file is opened.

### Event: 'close'

Emitted when a WriteStream's file has ended or closed. Comes from fs.close() method.

### writeStream.bytesWritten

The number of bytes written so far. Does not include data that is still queued
Expand Down