https://github.com/jgranstrom/zipson-stream
Stream support for zipson
https://github.com/jgranstrom/zipson-stream
compression parse stream stringify zipson
Last synced: 7 months ago
JSON representation
Stream support for zipson
- Host: GitHub
- URL: https://github.com/jgranstrom/zipson-stream
- Owner: jgranstrom
- License: mit
- Created: 2018-03-05T17:29:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-12T13:53:08.000Z (almost 8 years ago)
- Last Synced: 2025-03-28T08:41:36.247Z (10 months ago)
- Topics: compression, parse, stream, stringify, zipson
- Language: TypeScript
- Homepage: https://github.com/jgranstrom/zipson
- Size: 134 KB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# zipson-stream
[](https://travis-ci.org/jgranstrom/zipson-stream)
[](http://badge.fury.io/js/zipson-stream)
[](https://david-dm.org/jgranstrom/zipson-stream)
[](https://david-dm.org/jgranstrom/zipson-stream?type=dev)
zipson-stream adds node stream support to [zipson](https://github.com/jgranstrom/zipson), a JSON.parse/stringify alternative with added compression.
Try zipson with the [online demo](https://jgranstrom.github.io/zipson/)
---
- [Installing](#installing)
- [API](#api)
- [`stringifyStream(data, options?)`](#stringifystreamdata-options)
- [`parseStream(stream)`](#parsestreamstream)
- [Running the tests](#running-the-tests)
- [Contributing](#contributing)
- [Versioning](#versioning)
- [License](#license)
### Installing
`npm install --save zipson-stream`
### API
##### `stringifyStream(data, options?)`
Stringify data to a zipson stream. Compression options can be provided according to [zipson documentation](https://github.com/jgranstrom/zipson#options)
```javascript
import { stringifyStream } from 'zipson-stream';
// const { stringifyStream } = require('zipson-stream');
const myData = [1, 2, 3, 4 ,5];
const stream = stringifyStream(myData, options);
stream.pipe(process.stdout);
```
##### `parseStream(stream)`
Parse a zipson stream, resolves with the parsed data when the stream ends.
```javascript
import { parseStream } from 'zipson-stream';
// const { parseStream } = require('zipson-stream');
parseStream(myStringifiedStream)
.then(parsedData => {
console.log(parsedData);
});
```
### Running the tests
```npm test```
For running tests in watch mode while developing:
```npm run testw```
### Contributing
Pull requests are welcome. Please see the [conventional commits](https://conventionalcommits.org/) guidelines for commit message formatting.
### Versioning
This project is versioned using [SemVer](http://semver.org/) See [tags](https://github.com/jgranstrom/zipson-stream/tags) and [CHANGELOG.md](CHANGELOG.md) for version details.
### License
This project is licensed under the MIT License - see [LICENSE.md](LICENSE.md) file for details