Skip to content

Commit

Permalink
Docs: Document contents (closes #50, closes #51)
Browse files Browse the repository at this point in the history
  • Loading branch information
yocontra authored and phated committed Sep 27, 2016
1 parent f90657f commit 550ff25
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,17 @@ Returns the stream.

Returns a pretty String interpretation of the File. Useful for console.log.

### contents

The [Stream](https://nodejs.org/api/stream.html#stream_stream) or [Buffer](https://nodejs.org/api/buffer.html#buffer_class_buffer) of the file as it was passed in via options, or as the result of modification.

For example:
```js
if (file.isBuffer()) {
console.log(file.contents.toString()); // logs out the string of contents
}
```

### path

Absolute pathname string or `undefined`. Setting to a different value pushes the old value to `history`.
Expand Down

0 comments on commit 550ff25

Please sign in to comment.