json-lines

json-lines

json-lines streams JSON Lines.

Installation

$ npm install json-lines

Quick start

First you need to add a reference to json-lines in your application.

var jsonLines = require('json-lines');

To send JSON you need an Express application and a route that you want to use. Then subscribe to the open and close events to initialize or end data transfer.

app.get('/events', jsonLines(function (client) {
  client.once('open', function () {
    // ...
  });

  client.once('close', function () {
    // ...
  });
}));

Within the open event handler, you can use the send function to actually stream data to the client.

client.send({
  foo: 'bar'
});

If you want to close the connection, call the close function. This will emit the close event and clean up any event listeners.

client.close();

Running the build

This module can be built using Grunt. Besides running the tests, this also analyses the code. To run Grunt, go to the folder where you have installed json-lines and run grunt. You need to have grunt-cli installed.

$ grunt

License

The MIT License (MIT) Copyright (c) 2015 the native web.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.