Skip to content
PDF Oxide

Biblioteca PDF para Node.js — PDF Oxide

PDF Oxide é a biblioteca PDF mais rápida para Node.js: 0,8 ms em média por página, 5× mais rápida que o PyMuPDF, 15× mais rápida que o pypdf e 100 % de sucesso em 3 830 PDFs. Um único pacote para extrair, criar e editar PDFs — com definições TypeScript incluídas. Licença MIT / Apache-2.0.

Rodando em navegador, Deno, Bun ou Cloudflare Workers? Use o build WASM — mesma API, sem binários nativos. O addon nativo desta página é para Node.js e Electron.

Instalação

npm install pdf-oxide

Requisitos: Node.js 18 ou mais recente. Sem dependências de sistema. Sem toolchain Rust. Os addons .node pré-compilados para Linux (glibc + musl) x64/arm64, macOS x64/arm64 e Windows x64/arm64 são baixados automaticamente via optionalDependencies específicas por plataforma — nada é compilado na instalação.

Abrindo um PDF

JavaScript

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("research-paper.pdf");
console.log(`Pages: ${doc.getPageCount()}`);

const { major, minor } = doc.getVersion();
console.log(`PDF version: ${major}.${minor}`);

doc.close();

TypeScript

import { PdfDocument } from "pdf-oxide";

const doc: PdfDocument = new PdfDocument("research-paper.pdf");
const pageCount: number = doc.getPageCount();
const { major, minor }: { major: number; minor: number } = doc.getVersion();
console.log(`${pageCount} pages, PDF ${major}.${minor}`);
doc.close();

No Node.js 22+ dá para usar using e liberar recursos automaticamente:

{
  using doc = new PdfDocument("report.pdf");
  const text = doc.extractText(0);
} // doc.close() é chamado automaticamente

API de páginas

Desde a v0.3.34 PdfDocument é iterável e doc.page(i) retorna um PdfPage com width / height / rotation em cache, além de métodos de extração por página.

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("paper.pdf");
for (const page of doc) {
  console.log(`Page ${page.index}: ${page.width}x${page.height} (rotation ${page.rotation})`);
  const md = page.markdown();
  const tables = page.tables();       // linhas e células com bboxes
}
doc.close();

Indexação: doc.page(0), doc.page(-1) (última página). Métodos de página: text(), markdown(), html(), plainText(), words(), lines(), tables(), images(), paths(), annotations(), fonts(), search(query, caseSensitive).

Extração de texto

Uma página

JavaScript

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("report.pdf");
const text = doc.extractText(0);
console.log(text);
doc.close();

TypeScript

import { PdfDocument } from "pdf-oxide";

const doc: PdfDocument = new PdfDocument("report.pdf");
const text: string = doc.extractText(0);
console.log(text);
doc.close();

Todas as páginas

const doc = new PdfDocument("book.pdf");
const pageCount = doc.getPageCount();

for (let i = 0; i < pageCount; i++) {
  console.log(`--- Page ${i + 1} ---`);
  console.log(doc.extractText(i));
}

doc.close();

Extração assíncrona

Cada método síncrono tem um equivalente *Async que roda no thread pool do libuv. Use esses métodos em handlers HTTP e outro código de servidor concorrente para que a extração não bloqueie o event loop.

const { PdfDocument } = require("pdf-oxide");

async function extract(path) {
  const doc = new PdfDocument(path);
  try {
    return await doc.extractTextAsync(0);
  } finally {
    doc.close();
  }
}

Veja o guia de async para padrões como Promise.all espalhado entre páginas.

Extração estruturada

Dados em nível de caractere e de span, com posições e metadados de fonte:

const chars = doc.extractChars(0);
for (const ch of chars.slice(0, 10)) {
  console.log(`'${ch.char}' at (${ch.x.toFixed(1)}, ${ch.y.toFixed(1)}) ` +
              `size=${ch.fontSize.toFixed(1)} font=${ch.fontName}`);
}

const spans = doc.extractSpans(0);
for (const span of spans) {
  console.log(`"${span.text}" font=${span.fontName} size=${span.fontSize}`);
}

Extração por palavra e linha, com segmentação configurável:

const words = doc.extractWords(0);
const lines = doc.extractTextLines(0, { wordGapThreshold: 2.5, lineGapThreshold: 1.2 });

Conversão para Markdown

JavaScript

const md = doc.toMarkdown(0, { detectHeadings: true });
console.log(md);

// Todas as páginas
const allMd = doc.toMarkdownAll();

TypeScript

const md: string = doc.toMarkdown(0, { detectHeadings: true });
const allMd: string = doc.toMarkdownAll();

Conversão para HTML

const html = doc.toHtml(0);
const allHtml = doc.toHtmlAll();

Extração de imagens

const { writeFileSync } = require("fs");

const doc = new PdfDocument("brochure.pdf");
const images = doc.extractImages(0);

for (const [i, img] of images.entries()) {
  console.log(`Image ${i}: ${img.width}x${img.height} ${img.format} (${img.data.length} bytes)`);
  writeFileSync(`image_${i}.${img.format}`, img.data);
}

doc.close();

As imagens extraídas de PDFs com cor Indexed são expandidas automaticamente para RGB, incluindo paletas indexadas de 1/2/4/8 bpc com espaços de cor base RGB, escala de cinza ou CMYK.

Abrindo a partir de bytes

Abra um PDF a partir de bytes em memória — útil ao baixar de S3, HTTP ou de bancos de dados:

const { PdfDocument } = require("pdf-oxide");
const { readFileSync } = require("fs");

const bytes = readFileSync("document.pdf");
const doc = PdfDocument.openFromBytes(bytes);
const text = doc.extractText(0);
doc.close();

PDFs com senha

const doc = PdfDocument.openWithPassword("confidential.pdf", "secret");
const text = doc.extractText(0);
doc.close();

Você também pode autenticar após abrir:

const doc = new PdfDocument("confidential.pdf");
if (doc.authenticate("secret")) {
  console.log(doc.extractText(0));
}
doc.close();

PDFs AES-256 (V=5, R=6) têm suporte completo — incluindo captions de widgets push-button e caches de objeto corretamente invalidados após autenticação tardia.

Criação de PDFs

A classe Pdf oferece métodos de fábrica para criar PDFs a partir de vários formatos de origem.

A partir de Markdown

const { Pdf } = require("pdf-oxide");
const { writeFileSync } = require("fs");

const pdf = Pdf.fromMarkdown("# Hello World\n\nThis is a PDF.");
writeFileSync("output.pdf", pdf.toBytes());

A partir de HTML

const pdf = Pdf.fromHtml("<h1>Invoice</h1><p>Amount due: $42.00</p>");
writeFileSync("invoice.pdf", pdf.toBytes());

A partir de texto puro

const pdf = Pdf.fromText("Plain text document.\n\nSecond paragraph.");
writeFileSync("notes.pdf", pdf.toBytes());

A partir de imagens

const pdf = Pdf.fromImage("scan.jpg");
writeFileSync("scan.pdf", pdf.toBytes());

Busca

const doc = new PdfDocument("manual.pdf");

// Buscar em todas as páginas
const results = doc.searchAll("configuration", { caseSensitive: false });
for (const r of results) {
  console.log(`Page ${r.page}: "${r.text}" at (${r.x.toFixed(0)}, ${r.y.toFixed(0)})`);
}

// Buscar em uma página
const pageResults = doc.searchPage(0, "configuration");
doc.close();

Para busca em streaming em documentos grandes, use SearchStream:

const { PdfDocument, SearchStream, SearchManager } = require("pdf-oxide");

const doc = new PdfDocument("large.pdf");
const manager = new SearchManager(doc);
const stream = new SearchStream(manager, "invoice");

stream.on("data", (r) => console.log(`page ${r.pageIndex + 1}: ${r.text}`));
stream.on("end", () => doc.close());

Detalhes no guia de Node.js streams.

Edição

Use DocumentEditor para metadados, operações de página, anotações e campos de formulário:

const { DocumentEditor } = require("pdf-oxide");

const editor = DocumentEditor.open("document.pdf");

// Metadados
editor.setTitle("Updated Title");
editor.setAuthor("Jane Doe");

// Operações de página
editor.rotatePage(0, 90);
editor.deletePage(5);
editor.movePage(2, 0);

// Formulários
editor.setFormFieldValue("employee.name", "Jane Doe");
editor.flattenForms();

editor.save("edited.pdf");
editor.close();

OCR

Habilite a feature ocr na instalação para usar OCR em páginas escaneadas:

npm install pdf-oxide --build-from-source -- --features ocr

const { PdfDocument, OcrEngine } = require("pdf-oxide");

const doc = new PdfDocument("scanned.pdf");
const ocr = new OcrEngine();

if (ocr.pageNeedsOcr(doc, 0)) {
  const text = ocr.extractText(doc, 0);
  console.log(text);
}

ocr.close();
doc.close();

Receitas de ponta a ponta estão no guia de OCR.

Segurança em threads

PdfDocument é Send + Sync — você pode compartilhar um único documento entre worker threads para ler páginas em paralelo. Os métodos *Async fazem isso automaticamente via thread pool do libuv; para padrões manuais de workers, veja concorrência.

Tratamento de erros

Todos os métodos lançam erro em caso de falha:

const { PdfDocument } = require("pdf-oxide");

try {
  const doc = new PdfDocument("document.pdf");
  const text = doc.extractText(0);
  doc.close();
} catch (err) {
  console.error(`Extraction failed: ${err.message}`);
}

Próximos passos