@gmb/bitmark-parser - v7.2.0
    Preparing search index...

    Interface TransformOptions

    Options for the transform function.

    interface TransformOptions {
        indent?: number;
        inputFormat?: InputFormat;
        mode?: OutputMode;
        outputFormat?: OutputFormat;
        patch?: string | PatchEntry[] | PatchDocument;
        postHook?: PostHook;
        preHook?: PreHook;
        pretty?: boolean;
        spacesAroundValues?: number;
        workers?: number;
    }
    Index
    indent? inputFormat? mode? outputFormat? patch? postHook? preHook? pretty? spacesAroundValues? workers?
    indent?: number

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

    inputFormat?: InputFormat

    Input format (default: "auto").

    mode?: OutputMode

    Output mode (default: "optimized").

    outputFormat?: OutputFormat

    Output format (default: "json").

    patch?: string | PatchEntry[] | PatchDocument

    A patch document (PLAN-179) — per-bit patches by selector, removes, 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.

    postHook?: PostHook

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

    preHook?: PreHook

    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.

    pretty?: boolean

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

    spacesAroundValues?: number

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

    workers?: number

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

    Settings
    Member Visibility

    On This Page
    Properties