ndj

ndjson

Streaming line delimited json parser + serializer

Showing:

Popularity

Downloads/wk

273K

GitHub Stars

56

Maintenance

Last Commit

1yr ago

Contributors

8

Package

Dependencies

5

Size (min+gzip)

11.1KB

License

BSD-3-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

ndjson

Streaming newline delimited json parser + serializer. Available as a JS API and a CLI.

NPM

Usage

const ndjson = require('ndjson')

ndjson.parse([opts])

Returns a transform stream that accepts newline delimited json buffers and emits objects of parsed data.

Example file:

{"foo": "bar"}
{"hello": "world"}

Parsing it:

fs.createReadStream('data.txt')
  .pipe(ndjson.parse())
  .on('data', function(obj) {
    // obj is a javascript object
  })
Options
  • strict can be set to false to discard non-valid JSON messages
  • All other options are passed through to the stream class.

ndjson.stringify([opts])

Returns a transform stream that accepts JSON objects and emits newline delimited json buffers.

example usage:

var serialize = ndjson.serialize()
serialize.on('data', function(line) {
  // line is a line of stringified JSON with a newline delimiter at the end
})
serialize.write({"foo": "bar"})
serialize.end()
Options

Options are passed through to the stream class.

LICENSE

BSD-3-Clause

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial