Skip to content

Commit dae1d7d

Browse files
committed
Clean up readme
1 parent 93a305e commit dae1d7d

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,44 @@
1-
stream-to-promise [![Build Status](https://travis-ci.org/bendrucker/stream-to-promise.svg)](https://travis-ci.org/bendrucker/stream-to-promise) [![NPM version](https://badge.fury.io/js/stream-to-promise.svg)](http://badge.fury.io/js/stream-to-promise)
1+
stream-to-promise [![Build Status](https://travis-ci.org/bendrucker/stream-to-promise.svg)](https://travis-ci.org/bendrucker/stream-to-promise)
22
=================
33

4-
Convert streams (readable or writable) to promises
4+
> Convert streams (readable or writable) to promises
55
6+
## Installing
7+
8+
```sh
9+
$ npm install --save[-dev] stream-to-promise
10+
```
11+
12+
## Examples
13+
14+
### Readable Streams
615

716
```js
817
streamToPromise(readableStream).then(function (buffer) {
918
// buffer.length === 3
10-
});
11-
readableStream.emit('data', new Buffer());
12-
readableStream.emit('data', new Buffer());
13-
readableStream.emit('data', new Buffer());
14-
readableStream.emit('end'); // promise is resolved here
19+
})
20+
readableStream.emit('data', new Buffer())
21+
readableStream.emit('data', new Buffer())
22+
readableStream.emit('data', new Buffer())
23+
readableStream.emit('end') // promise is resolved here
1524
```
1625

26+
### Writable Streams
27+
1728
```js
1829
streamToPromise(writableStream).then(function () {
1930
// resolves undefined
20-
});
21-
writableStream.write('data');
22-
writeableStream.end(); // promise is resolved here
31+
})
32+
writableStream.write('data')
33+
writeableStream.end() // promise is resolved here
2334
```
2435

36+
### Error Handling
37+
2538
```js
26-
var err = new Error();
39+
var err = new Error()
2740
streamToPromise(stream).catch(function (error) {
28-
// error === err;
29-
});
30-
stream.emit('error', err); // promise is rejected here
41+
// error === err
42+
})
43+
stream.emit('error', err) // promise is rejected here
3144
```

0 commit comments

Comments
 (0)