diff options
Diffstat (limited to 'node_modules/vinyl/README.md')
| -rw-r--r-- | node_modules/vinyl/README.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/node_modules/vinyl/README.md b/node_modules/vinyl/README.md index a36777fb6..3861c4636 100644 --- a/node_modules/vinyl/README.md +++ b/node_modules/vinyl/README.md @@ -87,9 +87,9 @@ Default: `undefined` ##### `options.contents` -The contents of the file. If `options.contents` is a [`Stream`][stream], it is wrapped in a [`cloneable-readable`][cloneable-readable] stream. +The contents of the file. If `options.contents` is a [`ReadableStream`][readable-stream], it is wrapped in a [`cloneable-readable`][cloneable-readable] stream. -Type: [`Stream`][stream], [`Buffer`][buffer], or `null` +Type: [`ReadableStream`][readable-stream], [`Buffer`][buffer], or `null` Default: `null` @@ -164,11 +164,11 @@ Each Vinyl object will have instance properties. Some may be unavailable based o #### `file.contents` -Gets and sets the contents of the file. If set to a [`Stream`][stream], it is wrapped in a [`cloneable-readable`][cloneable-readable] stream. +Gets and sets the contents of the file. If set to a [`ReadableStream`][readable-stream], it is wrapped in a [`cloneable-readable`][cloneable-readable] stream. -Throws when set to any value other than a [`Stream`][stream], a [`Buffer`][buffer] or `null`. +Throws when set to any value other than a [`ReadableStream`][readable-stream], a [`Buffer`][buffer] or `null`. -Type: [`Stream`][stream], [`Buffer`][buffer] or `null` +Type: [`ReadableStream`][readable-stream], [`Buffer`][buffer], or `null` #### `file.cwd` @@ -355,7 +355,7 @@ Static method used by Vinyl when setting values inside the constructor or when c Takes a string `property` and returns `true` if the property is not used internally, otherwise returns `false`. -This method is usefuly for inheritting from the Vinyl constructor. Read more in [Extending Vinyl][extending-vinyl]. +This method is useful for inheritting from the Vinyl constructor. Read more in [Extending Vinyl][extending-vinyl]. Example: @@ -423,6 +423,7 @@ MIT [normalization]: #normalization-and-concatenation [extending-vinyl]: #extending-vinyl [stream]: https://nodejs.org/api/stream.html#stream_stream +[readable-stream]: https://nodejs.org/api/stream.html#stream_readable_streams [buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer [fs-stats]: http://nodejs.org/api/fs.html#fs_class_fs_stats [vinyl-fs]: https://github.com/gulpjs/vinyl-fs |