modern-pdf-lib

---

modern-pdf-lib / PdfStreamWriter

Class: PdfStreamWriter

Defined in: src/core/pdfStream.ts:67

A PDF writer that produces a ReadableStream<Uint8Array>.

Usage:

const streamWriter = new PdfStreamWriter(registry, structure, options);
const readable = streamWriter.toReadableStream();
// Pipe or consume the readable stream

The stream handles back-pressure automatically via the underlying TransformStream.

Constructors

Constructor

new PdfStreamWriter(registry, structure, options?): PdfStreamWriter

Defined in: src/core/pdfStream.ts:72

Parameters

registry

PdfObjectRegistry

All indirect objects.

structure

DocumentStructure

Document structure references.

options?

PdfSaveOptions

Returns

PdfStreamWriter

Methods

toReadableStream()

toReadableStream(): ReadableStream<Uint8Array<ArrayBufferLike>>

Defined in: src/core/pdfStream.ts:94

Create a ReadableStream<Uint8Array> that emits the complete PDF.

The stream respects back-pressure: it will not produce data faster than the consumer can handle.

Returns

ReadableStream<Uint8Array<ArrayBufferLike>>