it-protobuf-stream
it-protobuf-stream
+
Documentation
it
--Read and write protobuf messages over a duplex stream
+A collection of utilities for making working with iterables more bearable
About
- -This module makes it easy to send and receive length-prefixed Protobuf encoded -messages over streams.
-Example
import { pbStream } from 'it-protobuf-stream'
import { MessageType } from './src/my-message-type.js'
// RequestType and ResponseType have been generate from `.proto` files and have
// `.encode` and `.decode` methods for serialization/deserialization
const stream = pbStream(duplex)
// write a message to the stream
stream.write({
foo: 'bar'
}, MessageType)
// read a message from the stream
const res = await stream.read(MessageType)
-Install
$ npm i it-protobuf-stream
-Browser <script> tag
Loading this module through a script tag will make it's exports available as ItProtobufStream in the global namespace.
<script src="https://unpkg.com/it-protobuf-stream/dist/index.min.js"></script>
-Packages
-
+
packages/blob-to-itTurns a blob into an async iterator
+packages/browser-readablestream-to-itTurns a browser readble stream into an async iterator
+packages/it-allCollects all values from an (async) iterable and returns them as an array
+packages/it-batchTakes an async iterator that emits things and emits them as fixed size batches
+packages/it-batched-bytesTakes an async iterator that emits byte arrays and emits them as fixed size batches
+packages/it-buffer-streamAn async iterator that emits buffers containing bytes up to a certain length
+packages/it-byte-streamRead and write arbitrary bytes over a duplex stream
+packages/it-drainEmpties an async iterator
+packages/it-filterFilters the passed iterable by using the filter function
+packages/it-firstReturns the first result from an async iterator
+packages/it-flat-batchTakes an async iterator that emits variable length arrays and emits them as fixed size batches
+packages/it-foreachInvokes the passed function for each item in an iterable
+packages/it-globAsync iterable filename pattern matcher
+packages/it-lastReturns the last result from an async iterator
+packages/it-lengthCounts the number of items in an async iterable
+packages/it-length-prefixed-streamRead and write length-prefixed byte arrays over a duplex stream
+packages/it-mapMaps the values yielded by an async iterator
+packages/it-mergeTreat one or more iterables as a single iterable
+packages/it-multipartAsync iterable http multipart message parser
+packages/it-ndjsonParse iterators as ndjson and transform iterators to ndjson
+packages/it-parallelProcess incoming async(iterable) functions in parallel
+packages/it-parallel-batchProcess (async)iterable values as functions with concurrency control
+packages/it-peekableAllows peeking/pushing an iterable
+packages/it-protobuf-streamRead and write protobuf messages over a duplex stream
+packages/it-queueless-pushableA pushable queue that waits until a value is consumed before accepting another
+packages/it-reduceReduces the values yielded from an async iterator
+packages/it-rpcSchema-free RPC over async iterables
+packages/it-skipSkip items from an iterable
+packages/it-sortCollects all values from an async iterator, sorts them using the passed function and yields them
+packages/it-splitSplits Uint8Arrays emitted by an (async) iterable by a delimiter
+packages/it-takeStop iteration after n items have been received
+packages/it-to-browser-readablestreamTakes an async iterator and turns it into a browser readable stream
+packages/it-to-bufferTakes an async iterator that yields buffers and concatenates them all together
+
API Docs
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) +
- 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.
-
Optional override for formatting stack traces
+