/bsdiff-node

An binary diff and patch library based on bsdiff algorithm for NodeJS (Windows, Mac, Linux).

Primary LanguageCMIT LicenseMIT

CI NpmLicense

🔴 Project status: discontinued

  • Project is no longer in development
  • Issues are not accepted
  • Pull requests are not accepted
  • Repository is archived

bsdiff-node

An binary diff and patch library based on bsdiff algorithm for NodeJS (Windows, Mac, Linux)



If you find this package useful, please don't forget to star ⭐️ the repo, as this will help to promote the project.


Installation

Install as a dependency for your project (need python 3.x):

npm i bsdiff-node

Usage

const bsdiff = require('bsdiff-node');
bsdiff.diff(oldFile, newFile, patchFile, function(result, err) {}); // Async
bsdiff.patch(oldfile, newfile, patchfile, function(result, err) {}); // Async

bsdiff.diffSync(oldFile, newFile, patchFile); // Sync
bsdiff.patchSync(oldfile, newfile, patchfile); // Sync

For example:

const path = require('path');

const oldFile = path.join(__dirname, 'resources/react-0.3-stable.zip');
const newFile = path.join(__dirname, 'resources/react-0.4-stable.zip');
const patchFile = path.join(__dirname, 'resources/react.patch');
const generatedFile = path.join(__dirname, 'resources/react-generated.zip');

async function asyncCall() {
    await bsdiff.diff(oldFile, newFile, patchFile, function (result) {
        console.log('diff:' + String(result).padStart(4) + '%');
    });

    await bsdiff.patch(oldFile, generatedFile, patchFile, function (result) {
        console.log('patch:' + String(result).padStart(4) + '%');
    });
}
  
asyncCall();

License

The original algorithm and implementation was developed by Colin Percival. The algorithm is detailed in his paper, Naïve Differences of Executable Code. For more information, visit his website at http://www.daemonology.net/bsdiff/.

Copyright 2003-2005 Colin Percival
MIT © Dezeiraud