it-byte-stream

Read and write arbitrary bytes over a duplex stream

About

This module makes it easy to send and receive bytes over streams.

Example

import { byteStream } from 'it-byte-stream'

const stream = byteStream(duplex)

// read the next chunk
const bytes = await stream.read()

// read the next five bytes
const fiveBytes = await stream.read(5)

// write bytes into the stream
await stream.write(Uint8Array.from([0, 1, 2, 3, 4]))

Install

$ npm i it-byte-stream

Browser `<script>` tag

Loading this module through a script tag will make its exports available as ItByteStream in the global namespace.

<script src="https://unpkg.com/it-byte-stream/dist/index.min.js"></script>

API Docs

https://achingbrain.github.io/it/modules/it-byte-stream.html

License

Licensed under either of

Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Current Tags

2.0.6 ... latest (12 hours ago)