happypdf / ConvertToPDFAOptions

Interface: ConvertToPDFAOptions

Defined in: src/api/pdfa/index.ts:10

Options for [[PDFDocument.convertToPDFA]].

Properties

colorComponents?

optional colorComponents?: 3 | 4 | 1;

Defined in: src/api/pdfa/index.ts:39

The number of color components described by iccProfile (1 for grayscale, 3 for RGB, 4 for CMYK). Defaults to 3, matching the default sRGB profile.

---

conformance?

optional conformance?: PDFAConformanceLevel;

Defined in: src/api/pdfa/index.ts:16

The PDF/A conformance level to target. Defaults to '3B'.

See [[PDFAConformanceLevel]] for the list of supported values.

---

extensions?

optional extensions?: string[];

Defined in: src/api/pdfa/index.ts:49

Extra rdf:Description fragments to include in the initial XMP packet (e.g. Factur-X / ZUGFeRD schemas). They are written once on conversion and then preserved automatically across later saves when the Info dict changes.

Each entry must be a full <rdf:Description ...>...</rdf:Description> element using a namespace other than dc / xmp / pdf / pdfaid.

---

iccProfile?

optional iccProfile?: Uint8Array<ArrayBufferLike>;

Defined in: src/api/pdfa/index.ts:25

The raw bytes of the ICC color profile to embed as the document's output intent. Defaults to the bundled sRGB IEC61966-2.1 profile.

When you supply your own profile, make sure the color data used throughout the document matches its color space (e.g. an RGB profile for RGB colors).

---

outputConditionIdentifier?

optional outputConditionIdentifier?: string;

Defined in: src/api/pdfa/index.ts:32

A human-readable name identifying the output condition — i.e. the intended output device or production process the iccProfile characterizes. Defaults to 'sRGB IEC61966-2.1'.