git ssb

0+

wanderer🌟 / buffer-pipe



Commit bb08ba7fabe618c5ba831430d5478efdb59be6e5

updated docs

wanderer committed on 12/5/2017, 6:23:46 PM
Parent: 54caadc458ca1ac4c3d5d42c945f09165d3f15cd

Files changed

README.mdchanged
README.mdView
@@ -26,16 +26,20 @@
2626 # API
2727
2828 ## constructor
2929
30 +[index.js:8-10](https://github.com/wanderer/buffer-pipe/blob/54caadc458ca1ac4c3d5d42c945f09165d3f15cd/index.js#L8-L10 "Source code on GitHub")
31 +
3032 Creates a new instance of a pipe
3133
3234 **Parameters**
3335
34-- `buf` **[Buffer](https://nodejs.org/api/buffer.html)** an buffer to start with (optional, default `Buffer.from([])`)
36 +- `buf` **[Buffer](https://nodejs.org/api/buffer.html)** an optional buffer to start with (optional, default `Buffer.from([])`)
3537
3638 ## read
3739
40 +[index.js:17-21](https://github.com/wanderer/buffer-pipe/blob/54caadc458ca1ac4c3d5d42c945f09165d3f15cd/index.js#L17-L21 "Source code on GitHub")
41 +
3842 read `num` number of bytes from the pipe
3943
4044 **Parameters**
4145
@@ -44,12 +48,23 @@
4448 Returns **[Buffer](https://nodejs.org/api/buffer.html)**
4549
4650 ## write
4751
52 +[index.js:27-30](https://github.com/wanderer/buffer-pipe/blob/54caadc458ca1ac4c3d5d42c945f09165d3f15cd/index.js#L27-L30 "Source code on GitHub")
53 +
4854 Wites a buffer to the pipe
4955
5056 **Parameters**
5157
5258 - `buf` **[Buffer](https://nodejs.org/api/buffer.html)**
5359
60 +## end
61 +
62 +[index.js:36-38](https://github.com/wanderer/buffer-pipe/blob/54caadc458ca1ac4c3d5d42c945f09165d3f15cd/index.js#L36-L38 "Source code on GitHub")
63 +
64 +Whether or not there is more data to read from the buffer
65 +returns {Boolean}
66 +
5467 # LICENSE
55-[MPL-2.0](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2))
68 +[MPL-2.0][LICENSE]
69 +
70 +[LICENSE]: https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)

Built with git-ssb-web