Git Product home page Git Product logo

json-object-stream's Introduction

Json Object Stream

Installation

npm install json-object-stream

Example

var jos = require('json-object-stream');
// A stream containing the following json as buffer chunks
//
// [
//  {"name": "dave"},
//  {"name": "alan"},
//  {"name": "kate"}
// ]
var stream = ...

// docStream is a stream in ObjectMode, and will emit, in order
//
// {"name": "dave"}
// {"name": "alan"}
// {"name": "kate"}
//
// as json objects.
var docStream = stream.pipe(jos.parse());

Usage

The library contains three methods:

parse

var jos = require('json-object-stream');

stream.pipe(jos.parse()).pipe(...)

Takes a stream containing either an array or a single object as string/buffer chunks and emits parsed json objects as they become available. The resulting stream will be in ObjectMode, with each element being a json object.

stringify

var jos = require('json-object-stream');

stream.pipe(jos.stringify()).pipe(...)

Takes a stream in ObjectMode containing json documents, and stringifies them, inserting square brackets and commas before, after and in-between documents. Concatenating the resulting stream will result in a valid json array containing the objects from the stream. The resulting stream will still be in ObjectMode.

toBufferStream

var jos = require('json-object-stream');

stream.pipe(jos.stringify()).pipe(jos.toBufferStream)

Simple helper for turning ObjectMode off.

json-object-stream's People

Contributors

ketilovre avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

aidenzuk gobie

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.