Socket
Socket
Sign inDemoInstall

docx-builder

Package Overview
Dependencies
4
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

docx-builder

Easily create or merge DOCX files from Node.js


Version published
Maintainers
1
Weekly downloads
164
increased by21.48%

Weekly downloads

Readme

Source

docx-builder

An NPM module for creating and/or merging DOCX files.

How to install

Using npm do:

npm install docx-builder

View in npm

Example

var builder = require('docx-builder');
var docx = new builder.Document();

//SET THE HEADER

docx.beginHeader();
docx.insertText("This is the header");
docx.endHeader();

//SET THE FOOTER

docx.beginFooter();
docx.insertText("This is the footer");
docx.endFooter();

//COMMON OPERATIONS

docx.setBold();
docx.unsetBold();
docx.setItalic();
docx.unsetItalic();
docx.setUnderline();
docx.unsetUnderline();
docx.setFont("Arial");
docx.setSize(40);
docx.rightAlign();
docx.centerAlign();
docx.leftAlign();
docx.insertText("Hello");

//INSERT A TABLE

docx.beginTable({ borderColor: "red", borderSize: 20 });
docx.insertRow();
docx.setItalic();
docx.setUnderline();
docx.insertText("ID");
docx.nextColumn();
docx.insertText("Username");
docx.nextRow();
docx.insertText("1");
docx.nextColumn();
docx.insertText("raulb");
docx.endTable();

//INSERT EXTERNAL FILES

docx.insertDocxSync(__dirname+"/test.docx");
docx.insertPageBreak();
docx.insertDocx(__dirname+"/test2.docx", function(err){
	if(err) console.log(err);
});

//SAVE THE DOCX FILE

docx.save(__dirname + "/output.docx", function(err){
	if(err) console.log(err);
});

Merging .docx files

A common requirement is to merge two or more .docx files into one. For that, just call insertDocxSync or insertDocx to append the content of your .docx files.

var builder = require('docx-builder');
var docx = new builder.Document();

//You can also do this asynchronously using the insertDocx method.
docx.insertDocxSync(__dirname+"/test1.docx"); 
docx.insertDocxSync(__dirname+"/test2.docx");
docx.insertDocxSync(__dirname+"/test3.docx");

//SAVING THE DOCX FILE

docx.save(__dirname + "/output.docx", function(err){
	if(err) console.log(err);
});

Keywords

FAQs

Last updated on 30 Sep 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc