npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

docx-merger

v1.2.2

Published

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

Downloads

7,290

Readme

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