doc: fs - add path property to Write/ReadStream #4368
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -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. | |||
There was a problem hiding this comment.
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 :-)
There was a problem hiding this comment.
@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
claudiorodriguez
force-pushed
the
doc-fs-stream-path
branch
from
90cc7f5
to
1f091a9
Compare
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
|
LGTM |
|
Landed in 310530b |
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>
Merged
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327