Package Exports

@ably/vcdiff-decoder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ably/vcdiff-decoder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vcdiff-decoder

Pure JavaScript vcdiff decoder that works with binary deltas from Google's open-vcdiff

(In Development)

const vcdiff = require('vcdiff-decoder');

let target = vcdiff.decodeSync(deltaBuffer, new Buffer('some dictionary string buffer'));
console.log(target.toString());

API

vcdiff.decodeSync(delta, source)

delta Buffer
source Buffer

Returns a Buffer object of the target.

delta is the binary encoding of the information needed to transform the source to the target. It is encoded as vcdiff, as specified in RFC 3284

source is the group of bytes to transform into the target. In delta encoding, this probably an old, cached version.

vcdiff.decode(delta, source)

Same as above except returns a Promise that either resolves with the target Buffer or rejects with an error.

Release checklist

Run grunt release:<type> (where type is "major", "minor", "patch", "prepatch")
Run grunt release:deploy
Visit https://github.com/ably-forks/vcdiff-decoder/tags and draft new release for the newly created tag