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.

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

doc: fs - add path property to Write/ReadStream #4368

Closed

Conversation

claudiorodriguez
Copy link
Contributor

Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

@@ -116,6 +116,10 @@ Stop watching for changes on the given `fs.FSWatcher`.

Emitted when the ReadStream's file is opened.

### readStream.path

The path to the file the stream will read from.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a bit suggestion: How about changing the will read from to is reading from, in my opinion, the -ing might be more exact for doing express streams. The same to below writeStream.path :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@yorkie I was on the fence about that one, considering the situations where you'd want to check "path", but I'll defer to your opinion since it matches consistency

Documents the "path" property on fs.WriteStream
and fs.ReadStream. See nodejs#4327
@ChALkeR ChALkeR added the doc Issues and PRs related to the documentations. label Dec 20, 2015
@mscdex mscdex added the fs Issues and PRs related to the fs subsystem / file system. label Dec 20, 2015
jasnell added a commit to jasnell/node that referenced this pull request Dec 30, 2015
A major reworking of the fs.markdown structure and text.
Moved things around so that they are organized by function,
included additional information so there is less of dependency
on knowledge of the POSIX API.

Other changes:
* Documents `.path` on `fs.ReadStream` and `fs.WriteStream` per
  nodejs#4368
* Include coverage of the file system encoding issue
* Example enhancements throughout
@jasnell
Copy link
Member

jasnell commented Jan 15, 2016

LGTM

jasnell pushed a commit that referenced this pull request Jan 15, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

PR-URL: #4368
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Jan 15, 2016

Landed in 310530b

@jasnell jasnell closed this Jan 15, 2016
evanlucas pushed a commit that referenced this pull request Jan 18, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

PR-URL: #4368
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jan 28, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

PR-URL: #4368
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 11, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

PR-URL: #4368
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit to MylesBorins/node that referenced this pull request Feb 11, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See nodejs#4327

PR-URL: nodejs#4368
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 11, 2016
MylesBorins pushed a commit to MylesBorins/node that referenced this pull request Feb 15, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See nodejs#4327

PR-URL: nodejs#4368
Reviewed-By: James M Snell <jasnell@gmail.com>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See nodejs#4327

PR-URL: nodejs#4368
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants