JSON BinPack is an open-source binary JSON serialization format with a strong focus on space efficiency. It can run in schema-driven and schema-less mode to encode any JSON document given a matching JSON Schema 2020-12 definition.
NOTE! This is a prototype pre-production JavaScript-based implementation to prove the feasability of the approach. See https://github.com/sourcemeta/jsonbinpack for the work-in-progress C++ implementation.
npm install --save jsonbinpack
const jsonbinpack = require('jsonbinpack')
// Declare a JSON Schema definition
const schema = {
$schema: 'https://json-schema.org/draft/2020-12/schema',
type: 'object',
properties: {
foo: { type: 'string' }
}
}
// (1) Compile the JSON Schema definition into an Encoding schema
const encodingSchema = await jsonbinpack.compileSchema(schema)
// (2) Serialize a matching JSON document using the Encoding schema
const buffer = jsonbinpack.serialize(encodingSchema, {
foo: 'bar'
})
// (3) Deserialize the buffer into the original JSON document
const result = jsonbinpack.deserialize(encodingSchema, buffer)
console.log(result)
> { foo: 'bar' }
Convert a JSON Schema definition into an Encoding schema for use with the
.serialize()
and .deserialize()
functions.
Serialize a JSON value according to an Encoding schema.
Deserialize a buffer according to an Encoding schema.
Requirements:
- Node.js
npm
- GNU Make
Installing dependencies:
npm install
Compiling the project:
make
# Run tests
make test
# Run linter
make lint
This project is released under the terms specified in the license.