Skip to content
forked from max-mapper/ndjson

Streaming line delimited json parser + serializer

Notifications You must be signed in to change notification settings

ndjson/ndjson.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

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

Options are passed through to the stream class.

LICENSE

BSD-3-Clause

About

Streaming line delimited json parser + serializer

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%