modern-pdf-lib

---

modern-pdf-lib / PdfStream

Class: PdfStream

Defined in: src/core/pdfObjects.ts:349

A PDF stream object — a dictionary followed by stream … endstream.

The data field holds the (possibly compressed) payload. The caller is responsible for setting /Length in the dict before serialization.

Constructors

Constructor

new PdfStream(dict, data): PdfStream

Defined in: src/core/pdfObjects.ts:353

Parameters

dict

PdfDict

Stream metadata dictionary.

data

Uint8Array

Raw stream data (already encoded / compressed).

Returns

PdfStream

Properties

data

data: Uint8Array

Defined in: src/core/pdfObjects.ts:357

Raw stream data (already encoded / compressed).

---

dict

readonly dict: PdfDict

Defined in: src/core/pdfObjects.ts:355

Stream metadata dictionary.

Methods

serialize()

serialize(writer): void

Defined in: src/core/pdfObjects.ts:385

Parameters

writer

ByteWriter

Returns

void

---

syncLength()

syncLength(): void

Defined in: src/core/pdfObjects.ts:381

Update /Length to reflect the current data size.

Returns

void

---

fromBytes()

static fromBytes(data, extraEntries?): PdfStream

Defined in: src/core/pdfObjects.ts:374

Create a stream from raw bytes. Sets /Length automatically.

Parameters

data

Uint8Array

extraEntries?

PdfDict

Returns

PdfStream

---

fromString()

static fromString(content, extraEntries?): PdfStream

Defined in: src/core/pdfObjects.ts:364

Create a stream from a plain UTF-8 string (e.g. content-stream operators). Sets /Length automatically.

Parameters

content

string

extraEntries?

PdfDict

Returns

PdfStream