Skip to content

Commit

Permalink
doc: add path property to Write/ReadStream in fs.markdown
Browse files Browse the repository at this point in the history
Documents the "path" property on fs.WriteStream
and fs.ReadStream. See #4327

PR-URL: #4368
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
claudiorodriguez authored and evanlucas committed Jan 18, 2016
1 parent 01bdafe commit a6c242f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/fs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 is reading from.

## Class: fs.Stats

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

### writeStream.path

The path to the file the stream is writing to.

## fs.access(path[, mode], callback)

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

0 comments on commit a6c242f

Please sign in to comment.