Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arjanfrans/node-compressed-binary-json-patch

Last synced: 12 days ago
JSON representation

Host: GitHub
URL: https://github.com/arjanfrans/node-compressed-binary-json-patch
Owner: arjanfrans
License: mit
Created: 2017-02-28T18:25:35.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-03-01T11:39:56.000Z (over 7 years ago)
Last Synced: 2024-10-31T17:11:46.343Z (18 days ago)
Language: JavaScript
Size: 7.81 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # compressed-binary-json-patch 

[![npm version](https://img.shields.io/npm/v/@arjanfrans/compressed-binary-json-patch.svg)](https://www.npmjs.com/package/@arjanfrans/compressed-binary-json-patch)

[![Build Status](https://travis-ci.org/arjanfrans/@arjanfrans/compressed-binary-json-patch.svg?branch=master)](https://travis-ci.org/arjanfrans/@arjanfrans/compressed-binary-json-patch)

[![Coverage Status](https://coveralls.io/repos/arjanfrans/@arjanfrans/compressed-binary-json-patch/badge.svg)](https://coveralls.io/r/arjanfrans/@arjanfrans/compressed-binary-json-patch)

[![devDependency Status](https://david-dm.org/arjanfrans/@arjanfrans/compressed-binary-json-patch/status.svg)](https://david-dm.org/arjanfrans/@arjanfrans/compressed-binary-json-patch#info=dependencies)

[![devDependency Status](https://david-dm.org/arjanfrans/@arjanfrans/compressed-binary-json-patch/dev-status.svg)](https://david-dm.org/arjanfrans/@arjanfrans/compressed-binary-json-patch#info=devDependencies)

Pack and unpack objects and compress them by substituting known keys in the object.

When packing a json patch is generated, a previous state of the object can be provided,

and it is converted to binary using [msgpack](https://github.com/msgpack). Unpacking applies

this process in reverse.

## Installation

```

npm install --save @arjanfrans/compressed-binary-json-patch

```

## Usage

See [tests](./test/index.js).