Commit 31e107f67632563f67b704ce2fb36eaa3e2475a5
link to st
ream convertersDominic Tarr committed on 5/10/2014, 12:04:12 PM
Parent: c07e91962bbeb7c9eb30258087f4c7e30933e122
Files changed
README.md | changed |
README.md | ||
---|---|---|
@@ -27,15 +27,23 @@ | ||
27 | 27 | |
28 | 28 | The best thing about pull-stream is that it can be completely lazy. |
29 | 29 | This is perfect for async traversals where you might want to stop early. |
30 | 30 | |
31 | +## Compatibily with node streams | |
32 | + | |
33 | +pull-streams are not _directly_ compatible with node streams, | |
34 | +but pull-streams can be converted into node streams with | |
35 | +[pull-stream-to-stream](https://github.com/dominictarr/pull-stream-to-stream) | |
36 | +and node streams can be converted into pull-stream using [stream-to-pull-stream](https://github.com/dominictarr/stream-to-pull-stream) | |
37 | + | |
38 | + | |
31 | 39 | ## Examples |
32 | 40 | |
33 | 41 | What if implementing a stream was this simple: |
34 | 42 | |
35 | 43 | ### Pipeable Streams |
36 | 44 | |
37 | -`pull.{Source,Through,Sink}` just wrap a function and give it a `.pipe(dest)`! | |
45 | +`pull.{Source,Through,Sink}` wraps a function and added a `type` property to signify what type of pull-stream it is. | |
38 | 46 | |
39 | 47 | ```js |
40 | 48 | var pull = require('pull-stream') |
41 | 49 |
Built with git-ssb-web