https://github.com/jaredhanson/node-jsonsp

JSON stream parser for Node.js.
https://github.com/jaredhanson/node-jsonsp

Last synced: 3 months ago
JSON representation

JSON stream parser for Node.js.

• Host: GitHub
• URL: https://github.com/jaredhanson/node-jsonsp
• Owner: jaredhanson
• License: mit
• Created: 2011-10-21T22:03:16.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2014-04-24T15:21:08.000Z (over 11 years ago)
• Last Synced: 2025-10-09T01:05:39.022Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 321 KB
• Stars: 17
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# JSONSP

[JSON](http://www.json.org/) stream parser for [Node](http://nodejs.org).

## Installation

    $ npm install jsonsp

Install from source code repository:

    $ git clone git@github.com:jaredhanson/node-jsonsp.git

    $ cd node-jsonsp

    $ npm install

JSONSP depends on [YAJL](http://lloyd.github.com/yajl/) and the

[YAJL binding for Node.js](https://github.com/vibornoff/node-yajl).  libyajl

must be installed on your system prior to installing JSONSP.

Install YAJL via [Homebrew](http://mxcl.github.com/homebrew/) on Mac OS X:

    $ brew install yajl

    $ CPLUS_INCLUDE_PATH=/usr/local/include LIBRARY_PATH=/usr/local/lib npm install

## Usage

#### Initialize Parser

Create a new JSON stream parser.  The parser will incrementally parse data from

a stream, and emit an `'object'` event each time it parses a fully-formed JSON

object.

    var parser = new jsonsp.Parser();

    parser.on('object', function(obj) {

      // do something with obj

    });

#### Parse Data from Stream

As chunks of data are read from a stream, they can be incrementally parsed by

the JSON stream parser.

    var req = http.request(options, function(res) {

      // feed each chunk of data incrementally to the JSON stream parser

      res.on('data', function(chunk) {

        parser.parse(chunk.toString('utf8'));

      });

    });

## Examples

For a complete, working example, refer to the [Twitter Streaming API example](https://github.com/jaredhanson/node-jsonsp/tree/master/examples/twitter-stream).

## Tests

    $ npm install

    $ make test

## Credits

  - [Jared Hanson](http://github.com/jaredhanson)

## License

(The MIT License)

Copyright (c) 2011-2012 Jared Hanson

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.