brrd / msoconvert

Convert Word and Excel documents in Node.js (Windows only)

msoconvert

Convert Word and Excel documents in Node.js (for Windows only). This is a wrapper around DocTo.

Microsoft Word/Excel must be installed on the system.

Installation

npm install msoconvert --save

Usage

const convert = require("msoconvert");

// All the folling options are strings:
convert({ 
  input, // Input file or directory path.
  output, // Output file or directory path.

  // The two following only apply if input is a directory:
  inputExt, // Extension to search for if directory.
  outputExt, // Output extension.

  // Recommended:
  encoding, // Output encoding (see below).

  // Additional options:
  use, // "word" (default) | "excel" | "powerpoint"
  format, // wdSaveFormat for output (see below).
  options // Additional arguments passed to docto.exe. Refer to DocTo documentation.
})
  // A promise is returned.
  .then(() => console.log("done"));

See DocTo documentation for more information about API and additional parameters.

encoding

Available encodings can be found in enums/msoencodings.json. It is possible to avoid the msoencoding prefix.

If encoding is not defined, msoconvert will use the default encoding defined in MS Office application settings. It is recommended to always define an encoding.

format

wdSaveFormat enums:

• https://docs.microsoft.com/en-us/dotnet/api/microsoft.office.interop.word.wdsaveformat
• https://docs.microsoft.com/en-us/dotnet/api/microsoft.office.interop.excel.xlfileformat

If format is not defined, msoconvert will try to guess the format from outputExt if provided (otherwise an error will be thrown).

msoconvert's Issues

Add an `unicode` option

Add an unicode option which would be an alias to options: '-E 65001'. See #1.

Log better errors

See example in #1. Stderr should be included in the log.

Error if document has unicode characters

Hello,

my document has unicode characters. But this error occured.

Error: Command failed: "c:\Users\myUser\Tool\node_modules\msoconvert\bin\docto.exe" --word --inputfile "C:\Users\myUser\test.doc" --outputfile "C:\Users\myUser\test.txt" --format wdFormatText msoEncodingUTF8

at ChildProcess.exithandler (child_process.js:308:12)
at ChildProcess.emit (events.js:315:20)
at maybeClose (internal/child_process.js:1048:16)
at Socket.<anonymous> (internal/child_process.js:439:11)
at Socket.emit (events.js:315:20)
at Pipe.<anonymous> (net.js:673:12) {

killed: false,
code: 200,
signal: null,
cmd: '"c:\Users\myUser\Tool\node_modules\msoconvert\bin\docto.exe" --word --inputfile "C:\Users\myUser\test.doc" --outputfile "C:\Users\myUser\test.txt" --format wdFormatText msoEncodingUTF8'
}

Here is my code.

    const convert = require("msoconvert");
    convert({
        use: 'WD',
        input: inputFileDoc, 
        output: outputFileTXT, 
        format: 'wdFormatText', 
        options: 'msoEncodingUTF8',
    })
    .then(() => console.log("done"))
    .catch((error) => {
        console.log(error)
    });

Could you help me to handle this issue?

Thank you in advance.

Add more options

Handle more options such as: compatibility mode, encoding, ignoremacos, BookmarkSource and DoNotOverwrite.

See all available options: https://github.com/tobya/DocTo