vellora

Appearance

Interface: RenderOptions ​

Defined in: packages/vellora/src/types.ts:83

Public render options. opts is the single carrier for render configuration and is forwarded to the orchestration and native layers. metadata, images, baseUrl, and fonts all have a rendering effect.

Properties ​

baseUrl? ​

optional baseUrl?: string

Defined in: packages/vellora/src/types.ts:120

Base URL used only to normalize a relative <img> src into the images lookup key. Never fetched.

chromium? ​

optional chromium?: ChromiumEngineOptions

Defined in: packages/vellora/src/types.ts:89

Browser-engine options forwarded only when the selected engine is "chromium".

engine? ​

optional engine?: RenderEngine

Defined in: packages/vellora/src/types.ts:85

Rendering backend. Omitted => "native"; "chromium" requires the optional Chromium engine.

fidelity? ​

optional fidelity?: FidelityOptions

Defined in: packages/vellora/src/types.ts:87

Template-level routing metadata used by engine: "auto".

fonts? ​

optional fonts?: Uint8Array<ArrayBufferLike>[]

Defined in: packages/vellora/src/types.ts:112

Custom font faces as raw TTF/OTF bytes. Each face registers into the deterministic font context (after the bundled faces) and is reachable from the document's CSS by its intrinsic embedded family name (font-family: "Inter") — the caller does not declare a family alias. Custom faces never override the CSS generics (sans-serif/serif/monospace stay bundled), and no host/system font is ever consulted, so an unreferenced face leaves output byte-identical. A non-Uint8Array entry rejects with VelloraInputError; bytes that are not a parseable font reject with font:invalid.

images? ​

optional images?: Record<string, Uint8Array<ArrayBufferLike>>

Defined in: packages/vellora/src/types.ts:118

Image bytes keyed by an <img>'s src string. A non-data: <img src> is resolved by looking up this map (its key optionally normalized against baseUrl); the format is detected from the bytes. A renderable <img> whose source does not resolve rejects with image:unresolved.

metadata? ​

optional metadata?: RenderMetadata

Defined in: packages/vellora/src/types.ts:102

Document metadata (title, creation date).

pdfa? ​

optional pdfa?: "PDF/A-2b"

Defined in: packages/vellora/src/types.ts:100

Emit an archival PDF using the named PDF/A profile. Currently only PDF/A-2b is supported.

strict? ​

optional strict?: boolean

Defined in: packages/vellora/src/types.ts:91

Strict-by-default: validate, never mutate. false runs @vellora/lint fixers first.

template? ​

optional template?: boolean

Defined in: packages/vellora/src/types.ts:98

Run vellora's built-in templating on the input. Omitted => true. false passes the HTML to the renderer untouched, so literal template delimiters (a double opening brace, or {%) in HTML already rendered by another engine (Handlebars, React, …) stay as text. Passing data together with template: false rejects with VelloraInputError, since that data would otherwise be silently ignored.