8000 Docs: Add note about event-stream being unsupported (closes #19) · gulpjs/async-done@0095812 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0095812

Browse files
committed
Docs: Add note about event-stream being unsupported (closes #19)
1 parent 7d40dfb commit 0095812

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Optionally takes a callback to call when async tasks are complete.
5858
* `Stream` or `EventEmitter` returned
5959
- Completion: [end-of-stream][end-of-stream] module
6060
- Error: [domains][domains]
61+
- __Note:__ Only actual streams are supported, not faux-streams; Therefore, modules like [`event-stream`][event-stream] are not supported.
6162
* `Child Process` returned
6263
- Completion [end-of-stream][end-of-stream] module
6364
- Error: [domains][domains]
@@ -88,14 +89,15 @@ Errors can be caused by:
8889

8990
MIT
9091

91-
[end-of-stream]: https://www.npmjs.org/package/end-of-stream
92+
[end-of-stream]: https://www.npmjs.com/package/end-of-stream
9293
[domains]: http://nodejs.org/api/domain.html
94+
[event-stream]: https://github.com/dominictarr/event-stream
9395
[promise-onfulfilled]: http://promisesaplus.com/#point-26
9496
[promise-onrejected]: http://promisesaplus.com/#point-30
9597
[observable-subscribe]: https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/subscribe.md
9698

9799
[downloads-image]: http://img.shields.io/npm/dm/async-done.svg
98-
[npm-url]: https://npmjs.org/package/async-done
100+
[npm-url]: https://www.npmjs.com/package/async-done
99101
[npm-image]: http://img.shields.io/npm/v/async-done.svg
100102

101103
[travis-url]: https://travis-ci.org/gulpjs/async-done

0 commit comments

Comments
 (0)
0