it-ndjson-stream v1.0.1

it-ndjson-stream

Read and write ndjson messages over a duplex stream

About

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

Example

import { ndjsonStream } from 'it-ndjson-stream'

const stream = ndjsonStream(duplex)

// read the next message
const obj = await stream.read()

// write a message
await stream.write({ hello: 'world' })

// write several messages
await stream.writeV([
  { hello: 'world' },
  { how: 'are you' }
])

Install

$ npm i it-ndjson-stream

Browser <script> tag

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

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

API Docs

• https://achingbrain.github.io/it/modules/it_length_prefixed_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.