Skip to content

modern-pdf-lib


modern-pdf-lib / PdfString

Class: PdfString

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

A PDF string — either literal (…) or hexadecimal <…>.

By default the constructor produces a literal string. Use the static helpers for explicit control.

Properties

hex

readonly hex: boolean

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

When true the string is serialized in hexadecimal form <…>.


value

readonly value: string

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

The raw string content (unescaped).

Methods

serialize()

serialize(writer): void

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

Parameters

writer

ByteWriter

Returns

void


hex()

static hex(value): PdfString

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

Create a hexadecimal string <…> from a plain string.

Parameters

value

string

Returns

PdfString


hexFromBytes()

static hexFromBytes(data): PdfString

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

Create a hexadecimal string from raw bytes.

Parameters

data

Uint8Array

Returns

PdfString


literal()

static literal(value): PdfString

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

Create a literal string (…).

Parameters

value

string

Returns

PdfString

Released under the MIT License.