PDF export API

Import functions, error classes, font helpers, and types from @docx-editor.dev/docx-to-pdf. The package uses the EigenPal Pro License.

Convert a document

exportPdf(source, options?) returns Promise<PdfExportResult>. The following example converts bytes and handles expected refusals; docxBytes and savePdf belong to your application:

import {
  exportPdf,
  PdfDocumentOpenError,
  PdfFidelityError,
  PdfOutputLimitError,
  PdfPageLimitError,
} from '@docx-editor.dev/docx-to-pdf';

try {
  const result = await exportPdf(docxBytes, { maxPages: 100 });
  await savePdf(result.bytes);
} catch (error) {
  if (error instanceof PdfFidelityError) {
    console.table(error.diagnostics);
  } else if (error instanceof PdfDocumentOpenError) {
    console.error(error.code, error.reason);
  } else if (error instanceof PdfPageLimitError || error instanceof PdfOutputLimitError) {
    console.error(error.code, error.actual, error.limit);
  } else {
    throw error;
  }
}

• source is a Uint8Array or Buffer, never a path, URL, stream, or live view.
• Conversion preserves the source and releases its session after success or failure.
• It needs Node.js ^20.16.0 || >=22.3.0. Browser and Edge runtimes are unsupported.
• Never retry a strict refusal automatically with weaker settings.

Set options

• fontResolutionTimeoutMs and resourceTimeoutMs must be positive finite numbers up to 2147483647. Other values throw RangeError. timeoutMs also applies during resource phases.
• measurer, producer, and reuseAcrossRevisions are unsupported and throw TypeError.
• Host CSS and revisionStyles never change PDF colors.
• RevisionMarkupOptions and ResolvedRevisionMarkup type partial and complete preferences.

For font sources, see Configure PDF fonts.

Read the result

The result is immutable, except the bytes array.

Diagnostics

Each PdfDiagnostic has code, message, and severity. Page diagnostics add zero-based pageIndex and one-based pageNumber; display pageNumber.

Handle unknown codes by severity, because the set can grow. A chart with a saved fallback exports it with no diagnostic. For unreported effects, see What renders.

Handle errors

A strict font refusal throws ExportResourceError with code: 'layoutFailed'. Use onFontResolution to keep its evidence. Failure codes use camelCase; diagnostic codes use kebab-case.

Reuse a session

• You own the session. Export failures, projection cancellation, and projection deadlines never dispose it.
• The open signal controls shared resource work and session lifetime. An exportPdfFrom signal stops only that export.
• An explicit displayMode uses the cached layoutFor(mode) projection.
• Sessions without admitted fonts and glyph capabilities are rejected.

For a complete example, see Export both formats from one session.

Limits

• Deadlines and output limits are in Set options. maxPages and maxOutputBytes do not limit process memory.
• Synchronous parsing, font work, and image work cannot stop mid-call.
• For a hard deadline or memory isolation, convert in a worker with resourceLimits.maxOldGenerationSizeMb and terminate it on timeout.
• Core also bounds DOCX parsing, fonts, images, and layout.

Next steps

• Integrate PDF conversion
• Configure PDF fonts
• Compare PDF and Markdown conversion