Blame view

node_modules/stream-serializer/README.md 742 Bytes
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  # stream-serializer
  
  wrap a stream of regular js objects into a stream of line seperated json.
  
  [![build status](https://secure.travis-ci.org/dominictarr/stream-serializer.png)](http://travis-ci.org/dominictarr/stream-serializer)
  
  [![testling badge](https://ci.testling.com/dominictarr/stream-serializer.png)](https://ci.testling.com/dominictarr/stream-serializer)
  
  ## example
  
  ``` js
  var json = require('stream-serializer').json
  
  json(stream) //return a stream that can be piped through a text stream.
  ```
  
  or
  
  ``` js
  var ss require('stream-serializer')
  
  //get your user to pass in a wrapper option
  //which may be the typeof stream that is supported
  //of a function that applys the wrapping.
  
  ss(opts.wrapper)(stream) 
  
  ```
  
  ## License
  
  MIT