Interface TransformOptions

Apply the change proposals the input itself carries ([.bit-diff], review notes with patch cards) and mark each applied one resolved (PLAN-264). A failed proposal leaves its target untouched and throws a PatchError.

With applyProposals: who is recorded as having resolved them.

With applyProposals: the resolution date recorded (default: today, UTC).

Indent size for pretty-printing (default: 2).

Bitmark output only: write inline marks classically ("classic", default — **bold**, ==x==|bold|) or as toggle tags ("toggle" — (+bold)x(-bold)). A mark with only one spelling keeps it.

Input format (default: "auto").

Output mode (default: "optimized").

Output format (default: "json").

A patch document (PLAN-179) — per-bit patches by selector, removes, replacements, inserts and moves — or the every-bit shorthand: a bare array of entries applied to every bit. Either form may be given as a JSON string. A string of bitmark is CHANGE PROPOSALS ([.bit-diff] bits, PLAN-264; diff(…, { outputFormat: "bitmark-patch" }) writes them), applied to the input.

Per-bit post-hook, run on the calling thread after each bit is rendered.

Per-bit pre-hook, run on the calling thread. Returns patches (applied after the static patch), an output-format override, or drop. Providing a preHook or postHook switches transform to the per-bit path; with neither, the whole document is transformed in a single pass.

Prettify the emitted JSON (default: false) — for bitmark output, the embedded JSON bodies of json-format bits.

Spaces around tag values in bitmark output, 0..=10 (default: 1).

Worker-thread count for transformParallel (Node only; default 4). Ignored by the synchronous transform.