Wondering what’s next for npm?Check out our public roadmap! »

stream-json-stringify

1.0.0 • Public • Published

Build Status Coverage

node-stream-json-stringify

JSON.stringify, streaming, non-blocking, for real this time.

JSON.stringify, exactly, except it doesn't block on big objects and returns a readable stream

To be clear, this implementation is way slower than the native JSON.stringify. However, it makes a specific effort not to block the event loop which can be useful for large payloads

Installation

npm install --save stream-json-stringify

Usage

var stringify = require('stream-json-stringify');
 
stringify(myBigObject).pipe(process.stdout);

As stringify is a readable stream, you can configure it by passing options to it.

stringify(someObject, { highWaterMark: 2048 })

It also accepts a maxIterationTicks as an option to limit the maximum number of times it is going to look for the next token to serialize during a given loop. It defaults to 100.

Test

You can run the tests with npm test. You will need to know mocha

Contributing

Anyone is welcome to submit issues and pull requests

License

MIT

Copyright (c) 2018 Florent Jaby

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.

Install

npm i stream-json-stringify

DownloadsWeekly Downloads

6

Version

1.0.0

License

MIT

Unpacked Size

102 kB

Total Files

14

Last publish

Collaborators

  • avatar