rdiff-patcher

1.0.5 • Public • Published

rdiff-patcher

A module for patching files using delta patch files generated with rdiff

Installation

$ npm install --save rdiff-patcher

Usage

rdiff-patcher will only apply patches generated by the rdiff delta module to a base file, it will not generate the delta file

const patcher = require('rdiff-patcher');
 
async function main() {
    const basePath = './files/newyork.pdf';
    const changedPath = './files/newyork-barcode.pdf';
    const patchPath = './files/newyork.bin';
    const outPath = './files/newyork-new.pdf';
 
    await patcher(basePath, patchPath, outPath);
}
 
main();

API

There's only one API method in rdiff-patcher

patcher(basePath, patchPath, outPath)

Arguments

  • basePath - the original file that was diffed using rdiff
  • patchPath - the patch (delta) file created with the rdiff delta command
  • outPath - the output path for the patched file

License

(The MIT License)

Copyright (c) 2017 OneFlow Systems

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.5
    1
    • latest

Version History

Package Sidebar

Install

npm i rdiff-patcher

Weekly Downloads

1

Version

1.0.5

License

MIT

Last publish

Collaborators

  • oneflow-old
  • oneflow-systems