it-pb-stream

it-pb-stream

A convenience-wrapper around protocol-buffers and lp-messages functions

Table of contents

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

Install

$ npm i it-pb-stream

Browser <script> tag

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

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

• Install
• Usage
• License
• Contribution

> npm install it-pb-stream

Usage

import { pbStream } from 'it-pb-stream'

const stream = pbStream(duplex)
stream.writeLP(buf)
stream.writePB(buf, def)
//.. etc

API Docs

• https://achingbrain.github.io/it-pb-stream

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.

Changelog

3.0.0 (2023-02-23)

⚠ BREAKING CHANGES

• The ProtobufStream type is now generic - it can be inferred from the return type of pbStream but may need to be specified where it it accepted as an argument

Bug Fixes

• derive unwrapped stream type from input (#39) (e85d75e)