Popularity
1.2
Stable
Activity
0.0
Stable
45
2
4

Code Quality Rank: L5
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Streams     Stream     Parse     Swap     Peek    

peek-stream alternatives and similar modules

Based on the "Streams" category

Do you think we are missing an alternative of peek-stream or a related project?

Add another 'Streams' Module

README

peek-stream

Transform stream that lets you peek the first line before deciding how to parse it

npm install peek-stream

build status dat

Usage

var peek = require('peek-stream')
var ldjson = require('ldjson-stream')
var csv = require('csv-parser')

var isCSV = function(data) {
  return data.toString().indexOf(',') > -1
}

var isJSON = function(data) {
  try {
    JSON.parse(data)
    return true
  } catch (err) {
    return false
  }
}

// call parser to create a new parser
var parser = function() {
  return peek(function(data, swap) {
    // maybe it is JSON?
    if (isJSON(data)) return swap(null, ldjson())

    // maybe it is CSV?
    if (isCSV(data)) return swap(null, csv())

    // we do not know - bail
    swap(new Error('No parser available'))
  })
}

The above parser will be able to parse both line delimited JSON and CSV

var parse = parser()

parse.write('{"hello":"world"}\n{"hello":"another"}\n')
parse.on('data', function(data) {
  console.log(data) // prints {hello:'world'} and {hello:'another'}
})

Or

var parse = parser()

parse.write('test,header\nvalue-1,value-2\n')
parse.on('data', function(data) {
  console.log(data) // prints {test:'value-1', header:'value-2'}
})

Per default data is the first line (or the first 65535 bytes if no newline is found). To change the max buffer pass an options map to the constructor

var parse = peek({
  maxBuffer: 10000
}, function(data, swap) {
  ...
})

If you want to emit an error if no newline is found set strict: true as well.

License

MIT


*Note that all licence references and agreements mentioned in the peek-stream README section above are relevant to that project's source code only.