Skip to content
streaming line delimited json parser + serializer
Branch: master
Clone or download
Latest commit 2bb834d Dec 5, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
cli.js
collaborators.md
index.js use json-stringify-safe Dec 5, 2016
package.json
readme.md
test.js

readme.md

ndjson

streaming newline delimited json parser + serializer. Available as a JS API or a command line tool

NPM

usage

var ndjson = require('ndjson')

ndjson.parse(opts)

returns a transform stream that accepts newline delimited json and emits objects

example newline delimited json:

data.txt:

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

If you want to discard non-valid JSON messages, you can call ndjson.parse({strict: false})

usage:

fs.createReadStream('data.txt')
  .pipe(ndjson.parse())
  .on('data', function(obj) {
    // obj is a javascript object
  })

ndjson.serialize() / ndjson.stringify()

returns a transform stream that accepts json objects and emits newline delimited json

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()

license

BSD-3-Clause

You can’t perform that action at this time.