it-length-prefixed-stream

it-length-prefixed-stream

Read and write length-prefixed byte arrays over a duplex stream

Table of contents

• Install
  • Browser <script> tag
• Usage
• License
• Contribution

Install

$ npm i it-length-prefixed-stream

Browser <script> tag

Loading this module through a script tag will make it's exports available as ItLengthPrefixedStream in the global namespace.

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

• Install
  • Browser <script> tag
• Usage
• License
• Contribution

> npm install it-pb-stream

Usage

import { lpStream } from 'it-length-prefixed-stream'

const stream = lpStream(duplex)

// read the next length-prefixed chunk
await stream.read()

// write a plain buffer, the length will be prefixed
await stream.write(buf)

//.. etc

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.