fetch-newline-delimited-json

This proposal is to create a fetch-newline-delimited-json package who can be used to make a request to a newline-delimited-json service and provide some way of being notified with the stream of objects and its completion.

Option 1: A promise that returns a CanJS-style event emitter

var fetchNDJSON = require("fetch-newline-delimited-json");

fetchNDJSON("/api/todos.ndjson", {}).then(function(eventEmitter){
  eventEmitter.on("row", function(ev, row){
    
  });
  eventEmitter.on("end", function(ev){
    
  });
  eventEmitter.on("error", function(ev, error){
    
  });
})

Pros:

• lightest weight for CanJS to implement

Considerations:

• Promise tells us if connection was successful

Option 2: A promise that returns a Kefir stream:

var fetchNDJSON = require("fetch-newline-delimited-json");

fetchNDJSON("/api/todos.ndjson", {}).then(function(stream){
  stream.onValue(function(row){
    
  });
  stream.onError(function(error){
    
  });
  stream.onEnd(function(){
    
  });
})

Pros:

• streams are nice because they more accurately represent a sequence of values.

Cons:

• heavier weight

Implementation details

This should work like the following CSV example, but use JSON.parse:

• CSV + fetch streaming example JSBin
• NDJson

[justinbmeyer]

@matthewp I thought about that, but I think response.body.pipeThrough isn’t available. Also, I don’t think TransferStreams are available. We might be able to provide our own pipeThrough that works with something that implements both the reader and writer spec.

[justinbmeyer]

Closing for https://github.com/canjs/can-ndjson-stream/issues/1