Git Product home page Git Product logo

docx-merger's Introduction

Docx-merger

Javascript Library for Merging Docx file in NodeJS and Browser Environment.

Purpose

To merge docx file using javascript which has rich contents.

The Library Preserves the Styles, Tables, Images, Bullets and Numberings of input files.

Table of Contents

  1. Installation
  2. Usage Nodejs
  3. Usage Browser
  4. TODO
  5. Known Issues

Installation

npm install docx-merger

Back to top

Usage Nodejs

Read input files as binary and pass it to the DocxMerger constructor fuction as a array of files.

Then call the save function with first argument as nodebuffer, check the example below.

var DocxMerger = require('docx-merger');

var fs = require('fs');
var path = require('path');

var file1 = fs
    .readFileSync(path.resolve(__dirname, 'template.docx'), 'binary');

var file2 = fs
    .readFileSync(path.resolve(__dirname, 'template1.docx'), 'binary');

var docx = new DocxMerger({},[file1,file2]);


//SAVING THE DOCX FILE

docx.save('nodebuffer',function (data) {
    // fs.writeFile("output.zip", data, function(err){/*...*/});
    fs.writeFile("output.docx", data, function(err){/*...*/});
});

Back to top

Usage Browser

  • Async Load files using jszip-utils and then call the callback in the innermost callback.
  • Call the save function wit first argument as blob.
  • Better use Promises instead of callbacks.
  • Callback causes callback hell issue.
Using Callback
<html>
<script src="../dist/docx-merger.min.js"></script>
<script src="https://fastcdn.org/FileSaver.js/1.1.20151003/FileSaver.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jszip-utils/0.0.2/jszip-utils.min.js"></script>
<!--
Mandatory in IE 6, 7, 8 and 9.
-->
<!--[if IE]>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jszip-utils/0.0.2/jszip-utils-ie.min.js"></script>
<![endif]-->
<script>
  function loadFile(url,callback){
      JSZipUtils.getBinaryContent(url,callback);
  }
  loadFile("template.docx",function(error,file1){
      loadFile("template1.docx",function(error,file2){

          var docx = new DocxMerger({},[file1,file2]);

          docx.save('blob',function (data) {
              saveAs(data,"output.docx");
          });
      })
  })
</script>
</html>
Using Promise
<html>
<script src="../dist/docx-merger.min.js"></script>
<script src="https://fastcdn.org/FileSaver.js/1.1.20151003/FileSaver.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jszip-utils/0.0.2/jszip-utils.min.js"></script>
<!--
Mandatory in IE 6, 7, 8 and 9.
-->
<!--[if IE]>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jszip-utils/0.0.2/jszip-utils-ie.min.js"></script>
<![endif]-->
<script>
  function loadFile(url,callback) {

      return new Promise(function (resolve, reject) {

          JSZipUtils.getBinaryContent(url, function (err, data) {
              if (err) reject(err);
              resolve(data);
          });
      });
  }
  Promise.all([loadFile("template.docx"), loadFile("template1.docx")]).then(function(files){

      var docx = new DocxMerger({},files);

      docx.save('blob',function (data) {
          saveAs(data,"output.docx");
      });

  },function (err) {
      alert(err);
  })
</script>
</html>

TODO

  • CLI Support
  • Unit Tests
  • ES6 Convertions

Back to top

Known Issues

  • Microsoft Word in windows Shows some error due to numbering.

Back to top

docx-merger's People

Contributors

apurvaojas avatar saknarak avatar alexanderlukin avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.