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

    Interface CanonicalizeOptions

    Options for the canonicalize function (the single same-format re-emit surface; mode covers what the removed optimize/fullize did).

    interface CanonicalizeOptions {
        indent?: number;
        inlineStyle?: InlineStyle;
        inputFormat?: InputFormat;
        mode?: OutputMode;
        pretty?: boolean;
        spacesAroundValues?: number;
    }
    Index
    indent? inlineStyle? inputFormat? mode? pretty? spacesAroundValues?
    indent?: number

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

    inlineStyle?: InlineStyle

    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.

    inputFormat?: InputFormat

    Input format (default: "auto"). The output is re-emitted in this same format — e.g. "html" in, html out. "auto" sniffs bitmark, JSON or JSONL.

    mode?: OutputMode

    Output mode (default: "optimized"; "full" emits all keys).

    pretty?: boolean

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

    spacesAroundValues?: number

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

    Settings
    Member Visibility

    On This Page
    Properties