GroupDocs.Conversion for Node.js via Java — Code Examples

This repository contains runnable code examples demonstrating how to use GroupDocs.Conversion for Node.js via Java to convert documents, spreadsheets, presentations, PDFs, images, emails, and more between various formats.

Quick Start

Prerequisites

Node.js 20 LTS or later
Java JRE/JDK 8+ (17 LTS recommended)
Java Environment: Set JAVA_HOME and add to PATH

Note: This project uses ES Modules (import/export syntax). Ensure your Node.js version supports ES Modules (Node.js 12+).

Windows PowerShell:

$env:JAVA_HOME="C:\Program Files\Java\jdk-17"
$env:Path="$env:JAVA_HOME\bin;$env:Path"

Linux/macOS:

export JAVA_HOME=/usr/lib/jvm/java-17-openjdk
export PATH=$JAVA_HOME/bin:$PATH

For detailed installation instructions and platform-specific notes, refer to the documentation:

Installation

npm install

This installs the bundled package (@groupdocs/groupdocs.conversion) referenced in package.json.

Running Examples

Run All Examples

Execute all examples:

npm start

Or directly:

node Examples/runExamples.js

Outputs are saved to Examples/Output/<example-name>/.

Example Structure

Examples are organized into three categories:

QuickStart

Minimal examples to get started:

setLicense.js - License setup from stream (callback-based API)
setLicenseFromFile.js - License setup from file path
setLicenseFromStream.js - License setup from file stream

BasicUsage

Core conversion functionality examples:

File	What It Demonstrates
`convertToPdf.js`	Convert DOCX to PDF
`convertToHtml.js`	Convert document to HTML
`convertToWordProcessing.js`	Convert PDF to DOCX
`convertToSpreadsheet.js`	Convert DOCX to XLSX
`convertToPresentation.js`	Convert DOCX to PPTX
`convertToImagePng.js`	Convert DOCX to PNG image
`getPossibleConversions.js`	Get all supported conversion formats for a document
`getSourceDocumenInfo.js`	Get document metadata and properties

AdvancedUsage

Advanced scenarios organized by feature:

Converting (`AdvancedUsage/Converting/`)

convertToPdfWithAdvancedOptions.js - Convert password-protected document to PDF with page selection, rotation, DPI, and custom dimensions
convertToHtmlWithAdvancedOptions.js - Convert password-protected document to HTML with fixed layout and page selection
convertToImageWithAdvancedOptions.js - Convert PDF to PNG with image transformations (flip, brightness, contrast, gamma, grayscale, resolution)
convertToWordProcessingWithAdvancedOptions.js - Convert PDF to DOCX with page selection and format specification
convertToSpreadsheetWithAdvancedOptions.js - Convert password-protected document to XLS with page selection
convertToPresentationWithAdvancedOptions.js - Convert password-protected document to PPT with page selection
common/addWatermark.js - Add watermark text during conversion
common/convertNConsecutivePages.js - Convert a range of consecutive pages
common/convertSpecificPages.js - Convert specific pages by page numbers

Loading (`AdvancedUsage/Loading/`)

LoadOptionsFromDifferentSources:

loadDocumentFromLocalDisk.js - Load document from local file system
loadDocumentFromStream.js - Load document from file stream
loadDocumentFromUrl.js - Download and convert document from URL

LoadOptionsByDocumentType:

PDF:

Pdf/convertPdfAndFlattenAllFields.js - Flatten PDF form fields during conversion
Pdf/convertPdfAndHideAnnotations.js - Hide PDF annotations during conversion
Pdf/convertPdfAndRemoveEmbeddedFiles.js - Remove embedded files from PDF

Word Processing:

WordProcessing/convertWordProcessingByHidingComments.js - Hide comments in Word documents
WordProcessing/convertWordProcessingByHidingTrackedChanges.js - Hide tracked changes in Word documents
WordProcessing/convertWordProcessingBySpecifyingFontSubstitution.js - Custom font substitution for Word documents

Spreadsheet:

Spreadsheet/convertSpreadsheetAndHideComments.js - Hide comments in spreadsheets
Spreadsheet/convertSpreadsheetByShowingGridLines.js - Show grid lines in spreadsheet conversion
Spreadsheet/convertSpreadsheetBySkippingEmptyRowsAndColumns.js - Skip empty rows and columns
Spreadsheet/convertSpreadsheetBySpecifyingRange.js - Convert specific row range (e.g., rows 10-30)
Spreadsheet/convertSpreadsheetBySpecifyingFontsubstitution.js - Custom font substitution for spreadsheets
Spreadsheet/convertSpreadsheetWithHiddenSheetsIncluded.js - Include hidden sheets in conversion

Presentation:

Presentation/convertPresentationByHidingComments.js - Hide comments in presentations
Presentation/convertPresentationBySpecifyingFontSubstitution.js - Custom font substitution for presentations
Presentation/convertPresentationWithHiddenSlidesIncluded.js - Include hidden slides in conversion

Text:

Txt/convertTxtBySpecifyingEncoding.js - Convert text files with specific encoding (e.g., Shift-JIS)
Txt/convertTxtByControllingLeadingSpacesBehavior.js - Control leading spaces behavior (convert to indent)
Txt/convertTxtByControllingTrailingSpacesBehavior.js - Control trailing spaces behavior (trim)

CSV:

Csv/convertCsvBySpecifyingDelimiter.js - Convert CSV with custom delimiter
Csv/convertCsvBySpecifyingEncoding.js - Convert CSV with specific encoding
Csv/convertCsvByConvertingDateTimeAndNumericData.js - Automatic date/time and numeric data conversion

XML:

Xml/convertXmlAsDataSourceToSpreadsheet.js - Convert XML as data source to spreadsheet

Email:

Email/convertEmailWithAlteringFieldsVisibility.js - Control email field visibility (header, addresses, etc.)

CAD:

Cad/convertCadAndSpecifyLayouts.js - Convert specific CAD layouts
Cad/convertCadAndSpecifyWidthAndHeight.js - Convert CAD with custom dimensions

Note:

Note/convertNoteBySpecifyingFontSubstitution.js - Custom font substitution for OneNote documents

Example Code Snippets

Basic Conversion (DOCX to PDF)

// BasicUsage/convertToPdf.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const convertOptions = new groupdocs.PdfConvertOptions();
const outputPath = `${Constants.OUTPUT_FOLDER}/ConvertToPdf.pdf`;
await converter.convert(outputPath, convertOptions);

Basic Conversion (Document to HTML)

// BasicUsage/convertToHtml.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const convertOptions = new groupdocs.MarkupConvertOptions();
const outputPath = `${Constants.OUTPUT_FOLDER}/ConvertToHtml.html`;
await converter.convert(outputPath, convertOptions);

Password-Protected Document

// AdvancedUsage/Converting/convertToPdfWithAdvancedOptions.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const loadOptions = new groupdocs.WordProcessingLoadOptions();
loadOptions.setPassword('12345');

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX_WITH_PASSWORD, loadOptions);
const convertOptions = new groupdocs.PdfConvertOptions();
convertOptions.setPageNumber(2);
convertOptions.setPagesCount(1);
convertOptions.setRotate(groupdocs.Rotation.On180);
convertOptions.setDpi(300);
convertOptions.setWidth(1024);
convertOptions.setHeight(768);

await converter.convert(outputPath, convertOptions);

Add Watermark

// AdvancedUsage/Converting/common/addWatermark.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const convertOptions = new groupdocs.PdfConvertOptions();

const watermark = new groupdocs.WatermarkTextOptions("Sample watermark");
watermark.setColor("red");
watermark.setWidth(100);
watermark.setHeight(100);
watermark.setBackground(true);

convertOptions.setWatermark(watermark);
await converter.convert(outputPath, convertOptions);

Convert Specific Pages

// AdvancedUsage/Converting/common/convertSpecificPages.js
import java from 'java';
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const ArrayList = java.import('java.util.ArrayList');

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const convertOptions = new groupdocs.PdfConvertOptions();

const pages = new ArrayList();
pages.add(1); // First page
pages.add(3); // Third page
convertOptions.setPages(pages);

await converter.convert(outputPath, convertOptions);

Load from Stream

// AdvancedUsage/Loading/LoadOptionsFromDifferentSources/loadDocumentFromStream.js
import { createReadStream } from 'fs';
import java from 'java';
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const readStream = createReadStream(Constants.SAMPLE_DOCX);
const stream = await groupdocs.readDataFromStream(readStream);

// Create Supplier<InputStream> that returns the stream
const streamSupplier = java.newProxy('java.util.function.Supplier', {
  get: function() {
    return stream;
  }
});

const converter = new groupdocs.Converter(streamSupplier);
const convertOptions = new groupdocs.PdfConvertOptions();

await converter.convert(outputPath, convertOptions);

Load from URL

// AdvancedUsage/Loading/LoadOptionsFromDifferentSources/loadDocumentFromUrl.js
import java from 'java';
import groupdocs from '@groupdocs/groupdocs.conversion';

const URL = java.import('java.net.URL');

const url = 'https://example.com/document.docx';
const stream = new URL(url).openStream();
const converter = new groupdocs.Converter(stream);
const convertOptions = new groupdocs.PdfConvertOptions();

await converter.convert(outputPath, convertOptions);

Get Document Info

// BasicUsage/getSourceDocumenInfo.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const documentInfo = converter.getDocumentInfo();

console.log(`Author: ${documentInfo.getAuthor()}`);
console.log(`Pages count: ${documentInfo.getPagesCount()}`);
console.log(`Width: ${documentInfo.getWidth()}`);
console.log(`Height: ${documentInfo.getHeight()}`);

Get Possible Conversions

// BasicUsage/getPossibleConversions.js
import groupdocs from '@groupdocs/groupdocs.conversion';
import Constants from './constants.js';

const converter = new groupdocs.Converter(Constants.SAMPLE_DOCX);
const conversions = converter.getPossibleConversions();

console.log(`Source type: ${conversions.getSource().getExtension()}`);

const items = conversions.getAll();
for (let i = 0; i < items.size(); i += 1) {
  const item = items.get(i);
  console.log(`${item.getFormat().getExtension()} as ${item.isPrimary() ? 'primary' : 'secondary'} conversion`);
}

Using the Examples Module

All examples are accessible through Examples/examples.js:

import examples from './Examples/examples.js';

// Basic examples
await examples.getPossibleConversions();
await examples.getSourceDocumentInfo();
await examples.convertToHtml();
await examples.convertToPdf();
await examples.convertToWordProcessing();
await examples.convertToSpreadsheet();
await examples.convertToPresentation();
await examples.convertToImagePng();

// Advanced examples
await examples.convertToPdfWithAdvancedOptions();
await examples.addWatermark();
await examples.convertConsecutivePagesPdf();
await examples.convertSpecificPagesPdf();
await examples.loadDocumentFromStream();
await examples.loadDocumentFromUrl();
await examples.convertPdfAndFlattenAllFields();
await examples.convertWordProcessingByHidingComments();

Project Structure

├── Examples/
│   ├── BasicUsage/              # Basic conversion examples
│   │   ├── convertToPdf.js
│   │   ├── convertToHtml.js
│   │   ├── convertToWordProcessing.js
│   │   ├── convertToSpreadsheet.js
│   │   ├── convertToPresentation.js
│   │   ├── convertToImagePng.js
│   │   ├── getPossibleConversions.js
│   │   └── getSourceDocumenInfo.js
│   │
│   ├── AdvancedUsage/          # Advanced features
│   │   ├── Converting/         # Advanced conversion scenarios
│   │   │   ├── convertToPdfWithAdvancedOptions.js
│   │   │   ├── convertToHtmlWithAdvancedOptions.js
│   │   │   ├── convertToImageWithAdvancedOptions.js
│   │   │   └── common/
│   │   │       ├── addWatermark.js
│   │   │       ├── convertNConsecutivePages.js
│   │   │       └── convertSpecificPages.js
│   │   │
│   │   └── Loading/           # Document loading options
│   │       ├── LoadOptionsFromDifferentSources/
│   │       │   ├── loadDocumentFromLocalDisk.js
│   │       │   ├── loadDocumentFromStream.js
│   │       │   └── loadDocumentFromUrl.js
│   │       │
│   │       └── LoadOptionsByDocumentType/
│   │           ├── Pdf/
│   │           ├── WordProcessing/
│   │           ├── Spreadsheet/
│   │           ├── Presentation/
│   │           ├── Txt/
│   │           ├── Csv/
│   │           ├── Xml/
│   │           ├── Email/
│   │           ├── Cad/
│   │           └── Note/
│   │
│   ├── QuickStart/            # Quick start examples
│   │   ├── setLicense.js
│   │   ├── setLicenseFromFile.js
│   │   └── setLicenseFromStream.js
│   │
│   ├── Resources/
│   │   └── SampleFiles/      # Sample input files
│   │       ├── sample.docx
│   │       ├── sample.pdf
│   │       ├── sample.xlsx
│   │       └── ...
│   │
│   ├── Output/                # Generated results (auto-created)
│   │
│   ├── constants.js           # File paths and configuration
│   ├── examples.js            # Example runner module
│   └── runExamples.js         # Run all examples
│
├── .env.example               # Environment variables template
├── package.json
└── README.md

Input and Output

Input Files: Examples/Resources/SampleFiles/ (configured in Examples/constants.js)
Output Files: Examples/Output/<example-name>/ (auto-created per example)

Modify Examples/constants.js to change paths if needed.

License Setup (Optional)

Examples run in trial mode by default. To use a license:

Option 1: Environment variable

Create .env:

GROUPDOCS_LICENSE=C:\path\to\license.lic

Option 2: Programmatic

import examples from './Examples/examples.js';
import Constants from './Examples/constants.js';

await examples.setLicenseFromFile(Constants.LICENSE_PATH);

Get a temporary license: GroupDocs Temporary License

Supported Formats

GroupDocs.Conversion supports conversion between 50+ document formats including:

Word Processing: DOC, DOCX, RTF, ODT, TXT
Spreadsheet: XLS, XLSX, CSV, ODS
Presentation: PPT, PPTX, ODP
PDF: PDF
Images: PNG, JPEG, BMP, TIFF, GIF, SVG
Markup: HTML, XML
Email: MSG, EML, EMLX
CAD: DWG, DXF, DWF
Note: ONE
And more...

For a complete list, see: Supported File Formats

Troubleshooting

Java Not Detected

Set JAVA_HOME and add to PATH (see Prerequisites above).

Build Errors

Install build tools:

Windows: Visual Studio Build Tools
Linux: sudo apt-get install build-essential
macOS: xcode-select --install

Output Permission Errors

Ensure write access to Examples/Output/ directory.

Missing Fonts

Install common fonts (especially on Linux servers):

Microsoft Core Fonts
Liberation Fonts
DejaVu Fonts

License Errors

If you see license-related messages, ensure:

License file path is correct in .env or Constants.LICENSE_PATH
License file is valid and not expired
License matches the product version

Resources

Documentation: docs.groupdocs.com/conversion/nodejs-java
API Reference: apireference.groupdocs.com/conversion/nodejs-java
Support Forum: forum.groupdocs.com/c/conversion
Product Page: products.groupdocs.com/conversion/nodejs-java

Note: These are code examples demonstrating GroupDocs.Conversion features. For production use, ensure you have a valid license.

Name		Name	Last commit message	Last commit date
Latest commit History 23 Commits
Examples		Examples
.env.example		.env.example
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
package.json		package.json

License

groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java

Folders and files

Latest commit

History

Repository files navigation

GroupDocs.Conversion for Node.js via Java — Code Examples

Quick Start

Prerequisites

Installation

Running Examples

Run All Examples

Example Structure

QuickStart

BasicUsage

AdvancedUsage

Converting (AdvancedUsage/Converting/)

Loading (AdvancedUsage/Loading/)

Example Code Snippets

Basic Conversion (DOCX to PDF)

Basic Conversion (Document to HTML)

Password-Protected Document

Add Watermark

Convert Specific Pages

Load from Stream

Load from URL

Get Document Info

Get Possible Conversions

Using the Examples Module

Project Structure

Input and Output

License Setup (Optional)

Supported Formats

Troubleshooting

Java Not Detected

Build Errors

Output Permission Errors

Missing Fonts

License Errors

Resources

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 2

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Converting (`AdvancedUsage/Converting/`)

Loading (`AdvancedUsage/Loading/`)

Packages