Skip to content

Commit 310530b

Browse files
claudiorodriguezjasnell
authored andcommitted
doc: add path property to Write/ReadStream in fs.markdown
Documents the "path" property on fs.WriteStream and fs.ReadStream. See #4327 PR-URL: #4368 Reviewed-By: James M Snell <[email protected]>
1 parent 3470574 commit 310530b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/api/fs.markdown

+8
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,10 @@ Stop watching for changes on the given `fs.FSWatcher`.
116116

117117
Emitted when the ReadStream's file is opened.
118118

119+
### readStream.path
120+
121+
The path to the file the stream is reading from.
122+
119123
## Class: fs.Stats
120124

121125
Objects returned from [`fs.stat()`][], [`fs.lstat()`][] and [`fs.fstat()`][] and their
@@ -196,6 +200,10 @@ Emitted when the WriteStream's file is opened.
196200
The number of bytes written so far. Does not include data that is still queued
197201
for writing.
198202

203+
### writeStream.path
204+
205+
The path to the file the stream is writing to.
206+
199207
## fs.access(path[, mode], callback)
200208

201209
Tests a user's permissions for the file specified by `path`. `mode` is an

0 commit comments

Comments
 (0)