zipson


Zipson is a drop-in alternative to JSON.parse/stringify with added compression and streaming support.

!demo

Try the online demo

---

- Installing
- API
- stringify(data, options?)
- stringifyTo(data, writer, options?)
- parse(string)
- parseIncremental()
- Options
- detectUtcTimestamps
- fullPrecisionFloats
- Writer
- Features
- Running the tests
- Contributing
- Versioning
- License

$3

As an npm module

npm install --save zipson

Or alternatively from jsdelivr with a script tag as a UMD bundle

$3

##### stringify(data, options?)

Stringify data to a zipson string

``javascript
import { stringify } from 'zipson';

const myData = [1, 2, 3, 4 ,5];
const stringified = stringify(myData, options);
`

##### stringifyTo(data, writer, options?)

Stringify data to a specific zipson writer

`javascript
import { stringifyTo, ZipsonStringWriter } from 'zipson';

const writer = new ZipsonStringWriter();
const myData = [1, 2, 3, 4, 5];
stringifyTo(myData, writer, options);
const stringified = writer.value;
`

##### parse(string)

Parse a zipson string

`javascript
import { parse } from 'zipson';

const myStringifiedData = '.......';
const parsed = parse(myStringifiedData);
`

##### parseIncremental()

Incrementally parse a zipson string. Call the returned function once for each chunk of the string, calling it with null will signal end of string and returned the parsed result.

`javascript
import { parseIncremental } from 'zipson';

const increment = parseIncremental();
increment(chunkOfStringifiedData1);
increment(chunkOfStringifiedData2);
increment(chunkOfStringifiedData3);
increment(chunkOfStringifiedData4);
const parsed = increment(null);
`

$3

Compression options can be provided to the stringify functions. Parse however does not take any options since it is not dependent on knowing with what options the string was compressed.

##### detectUtcTimestamps

Set to true to tell zipson to detect timestamps within strings such as '2018-01-01T00:00:00Z' in order to represent them more efficiently.

##### fullPrecisionFloats

By default floating point precision is reduced to 10^-3, set this to true in order to retain full floating point precision.

$3

Compression output is generalized to a writer class in order to support different output targets. Custom writers have to implement the following API.

`typescript
abstract class ZipsonWriter {

// Write a chunk of data
abstract write(data: string): void;

// End of writes
abstract end(): void;
}
`

$3

`npm test`

For running tests in watch mode while developing:

`npm run testw``

$3

Pull requests are welcome. Please see the conventional commits guidelines for commit message formatting.

$3

This project is versioned using SemVer See tags and CHANGELOG.md for version details.

$3

This project is licensed under the MIT License - see LICENSE.md file for details