PDFKit für JavaScript (Node.js): Komplettguide mit Beispielen

Einführung in PDFKit

PDFKit ist eine leistungsstarke und flexible Bibliothek zur serverseitigen Generierung von PDF-Dokumenten mit JavaScript (Node.js). Sie gibt Entwicklern die vollständige Kontrolle über den PDF-Erstellungsprozess – von einfachen Textdokumenten bis hin zu komplexen mehrseitigen Berichten mit Tabellen, Bildern, Grafiken und interaktiven Elementen. PDFKit benötigt keine zusätzlichen Abhängigkeiten wie PhantomJS oder Puppeteer und arbeitet ausschließlich mit reinem JavaScript. Das macht es zur idealen Wahl für hochlastige Serveranwendungen.

Warum braucht man diese Bibliothek? In der modernen Webentwicklung müssen oft PDF-Dokumente programmatisch erstellt werden: Rechnungen, Lieferscheine, Berichte, Zertifikate, Verträge. PDFKit löst diese Aufgabe elegant und effizient. Anders als HTML-to-PDF-Konverter, die langsam und unberechenbar sein können, gibt PDFKit Ihnen direkten Zugriff auf das PDF-Modell: Sie bestimmen selbst die Koordinaten jedes Elements, verwalten Schriftarten, Farben und das Seitenlayout. Das ist besonders wichtig, wenn eine präzise Positionierung von Elementen oder die Arbeit mit nicht standardmäßigen Formaten erforderlich ist.

Die Bibliothek wird von der Community aktiv unterstützt, verfügt über eine umfangreiche Dokumentation und wird von tausenden Unternehmen weltweit in der Produktion eingesetzt. PDFKit unterstützt alle wichtigen Funktionen des PDF-Formats: Einbettung von Schriftarten (inklusive kyrillischer Zeichen), Arbeit mit Bildern (JPEG, PNG, SVG), Erstellung von Anmerkungen, Hyperlinks, Lesezeichen sowie Dokumentenverschlüsselung. Dank der modularen Architektur und der Möglichkeit zur Stream-Ausgabe eignet sich PDFKit sowohl für kleine Dokumente als auch für mehrere Gigabyte große PDF-Dateien.

Installation von PDFKit

PDFKit wird über den Paketmanager npm vertrieben. Die Installation erfolgt mit dem Standardbefehl:

npm install pdfkit

Für die Arbeit mit TypeScript kann die Installation zusätzlicher Typdefinitionen erforderlich sein:

npm install pdfkit @types/pdfkit

Wenn Sie Yarn verwenden:

yarn add pdfkit

Nach der Installation ist die Bibliothek einsatzbereit. Es sind keine zusätzlichen Abhängigkeiten oder Systemanforderungen nötig – alles funktioniert "out of the box" auf jeder Plattform, die Node.js unterstützt (Windows, macOS, Linux).

Schnellstart: Minimales Arbeitsbeispiel

Erstellen Sie eine Datei hello-pdf.js und fügen Sie folgenden Code ein:

const PDFDocument = require('pdfkit');
const fs = require('fs');

// Neues PDF-Dokument erstellen
const doc = new PDFDocument();

// Ziel für die Ausgabe festlegen
doc.pipe(fs.createWriteStream('hello.pdf'));

// Text hinzufügen
doc.fontSize(25)
   .text('Hallo, Welt!', 100, 100);

// Dokument abschließen
doc.end();

console.log('PDF erstellt: hello.pdf');

Führen Sie das Skript aus:

node hello-pdf.js

Im aktuellen Verzeichnis erscheint die Datei hello.pdf mit dem Text "Hallo, Welt!". Dieses Beispiel zeigt das grundlegende Prinzip der Arbeit mit PDFKit: Dokument erstellen, Inhalt hinzufügen und Ergebnis speichern.

Wichtige Methoden und Klassen von PDFKit

PDFKit bietet eine umfangreiche API für die Arbeit mit PDF-Dokumenten. Sehen wir uns die wichtigsten Methoden an, die Sie im Entwicklungsalltag benötigen.

1. new PDFDocument(options) – Der Dokument-Konstruktor

Signatur: new PDFDocument([options])

Beschreibung: Erstellt eine neue Instanz eines PDF-Dokuments. Der Parameter options ist ein Objekt, mit dem Sie Seitengröße, Ränder, Ausrichtung, Metadaten und andere Einstellungen festlegen können.

const doc = new PDFDocument({
  size: 'A4',              // Seitengröße (A4, Letter, Legal usw.)
  layout: 'portrait',      // Ausrichtung: 'portrait' oder 'landscape'
  margins: {               // Seitenränder