Interface: RenderOptions

Defined in: packages/core/src/types.ts:92

Properties

assets?

optional assets?: AssetResolver

Defined in: packages/core/src/types.ts:107

Supplies fonts and images referenced by the log.

---

embedEditLog?

optional embedEditLog?: boolean

Defined in: packages/core/src/types.ts:113

Store canonicalJson({ log, index }) in the file's metadata so it can be reopened with readEmbeddedState. Off by default: the log may contain text the user does not want to ship.

---

mode?

optional mode?: "truth" | "preview"

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

truth (default) requires the buffer to have the logical source dimensions. preview accepts a proxy and scales lengths accordingly.

---

output

output: OutputOptions

Defined in: packages/core/src/types.ts:93

---

registry?

optional registry?: Registry

Defined in: packages/core/src/types.ts:105

Plugins that interpret the log's ops. Required when the log has ops.

---

signal?

optional signal?: AbortSignal

Defined in: packages/core/src/types.ts:101

---

upTo?

optional upTo?: number

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

Render only ops[0..upTo). Defaults to all ops.

---

wasm?

optional wasm?: SealpixelWasm

Defined in: packages/core/src/types.ts:103

Pre-loaded core. Servers pass this to reuse one instance across requests.