aboutsummaryrefslogtreecommitdiff
path: root/node_modules/get-stream/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-08-14 05:01:11 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-08-14 05:02:09 +0200
commit363723fc84f7b8477592e0105aeb331ec9a017af (patch)
tree29f92724f34131bac64d6a318dd7e30612e631c7 /node_modules/get-stream/readme.md
parent5634e77ad96bfe1818f6b6ee70b7379652e5487f (diff)
node_modules
Diffstat (limited to 'node_modules/get-stream/readme.md')
-rw-r--r--node_modules/get-stream/readme.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/node_modules/get-stream/readme.md b/node_modules/get-stream/readme.md
index a74866bb2..73b188fb4 100644
--- a/node_modules/get-stream/readme.md
+++ b/node_modules/get-stream/readme.md
@@ -46,7 +46,7 @@ getStream(stream).then(str => {
## API
-The methods returns a promise that is resolved when the `end` event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode.
+The methods returns a promise that resolves when the `end` event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode.
### getStream(stream, [options])
@@ -93,8 +93,10 @@ If the input stream emits an `error` event, the promise will be rejected with th
```js
getStream(streamThatErrorsAtTheEnd('unicorn'))
- .catch(err => console.log(err.bufferedData));
-// unicorn
+ .catch(err => {
+ console.log(err.bufferedData);
+ //=> 'unicorn'
+ });
```