ConvertOptions
Defined in: impl/js/src/types.ts:28
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
engine? | "auto" | "wasm" | "js" | Which render engine to use. - 'auto' (default) — try xl3-wasm if it's installed and instantiable; otherwise fall back to the ExcelJS path. Falls through to ExcelJS on any wasm-side error too. - 'wasm' — require xl3-wasm; throw if it's not available or the call errors. Useful in tests that need to assert the wasm path is the one being exercised. - 'js' — force the original ExcelJS path. Useful as a kill switch when a wasm regression is suspected. Stable Frozen at 1.0 — auto is the default and SHOULD remain so for forward compatibility. | impl/js/src/types.ts:45 |
inputs? | Record<string, unknown> | Host-provided values for inputs declared in the template's __inputs__ sheet. | impl/js/src/types.ts:30 |
signal? | AbortSignal | Host-supplied cancellation signal. When it aborts, the in-flight conversion raises xl3/abort/cancelled and emits no partial output. A conversion is CPU-bound and single-threaded, so the signal is observed at the pipeline's await boundaries — after the template parses, after sources are read, and between file groups — not mid-row. Hosts racing against a wall-clock budget get deterministic cancellation at those points rather than a torn result. Stable Frozen at 1.0 per spec/STABILITY.md. Additive: existing callers that omit it are unaffected. | impl/js/src/types.ts:59 |