Document redaction API for Node.js (powered by Java) to permanently remove or mask sensitive text, metadata, annotations, and image areas from PDF, Word, Excel, PowerPoint, images, and other supported formats.

Quick links

• Product Home
• Release Notes
• Documentation
• System Requirements
• Installation Guide
• Support
• Pricing

Key Features

• Redact text with exact phrase or regular expression (replacement text or colored box).
• Erase or search/replace metadata and annotations.
• Redact image areas and embedded images; optional OCR connectors.
• Spreadsheet column filters and page remove/rasterize workflows.
• Save in the original format or as a rasterized PDF.
• Same public API surface as GroupDocs.Redaction for Java (via Node.js bridge).

Supported Formats

Redact documents in supported file formats (PDF, DOCX, XLSX, PPTX, images, and more).

Getting Started

Prerequisites

• Node.js (LTS recommended)
• Java Runtime Environment (JRE) 8 or later (JAVA_HOME configured)
• Windows, Linux, or macOS

Installation

npm i @groupdocs/groupdocs.redaction

The postinstall script downloads groupdocs-redaction-nodejs-26.10.jar into lib/.

Use cases

Exact phrase redaction

const redaction = require('@groupdocs/groupdocs.redaction');

const license = new redaction.License();
license.setLicense('GroupDocs.Redaction.lic');

const redactor = new redaction.Redactor('sample.docx');
try {
  redactor.apply(new redaction.ExactPhraseRedaction(
    'John Doe',
    new redaction.ReplacementOptions('[personal]')));
  redactor.save();
} finally {
  redactor.close();
}

Regex redaction with colored box

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');

const redactor = new redaction.Redactor('sample.pdf');
try {
  redactor.apply(new redaction.RegexRedaction(
    '\\d{3}-\\d{2}-\\d{4}',
    new redaction.ReplacementOptions(Color.BLACK)));
  const options = new redaction.SaveOptions();
  options.setRasterizeToPDF(true);
  redactor.save(options);
} finally {
  redactor.close();
}

Build notes (maintainers)

1. Publish JAR from java-new with -Pfinal,nodejs (com.groupdocs:groupdocs-redaction-nodejs:26.10).
2. Init submodule: git submodule update --init --recursive
3. GenJS (CI build_stage or local Gradle in java-to-node.js-generator) produces lib/groupdocs.redaction.js using regex over com.groupdocs.redaction.** (excluding internal).
4. ProGuard / jarjar rules live only in the Java repo (config/groupdocs-redaction.pro, groupdocs-redaction.rules).

Licensing

This library is supplied under the GroupDocs End User License Agreement. Evaluation mode applies without a license (see documentation).