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

    Interface ConvertWithDetailsOptions

    Options for convertWithDetails: ConvertOptions plus one flag per extra to return.

    interface ConvertWithDetailsOptions {
        bitAnchors?: boolean;
        bitSpans?: boolean;
        includeUnknownProperties?: boolean;
        indent?: number;
        inlineStyle?: InlineStyle;
        inputFormat?: InputFormat;
        mappingReport?: boolean;
        mode?: OutputMode;
        outputFormat?: "auto" | OutputFormat;
        plainText?: boolean;
        positionEncoding?: PositionEncoding;
        pretty?: boolean;
        spacesAroundValues?: number;
        tokensLayout?: TokensLayout;
        warnings?: boolean;
    }

    Hierarchy (View Summary)

    Index
    bitAnchors?: boolean

    Return ConvertResult.bitAnchors (default: false), counted in positionEncoding like the spans.

    bitSpans?: boolean

    Return ConvertResult.bitSpans (default: false). Offsets are counted in positionEncoding (default "utf-16", what JavaScript strings index by).

    includeUnknownProperties?: boolean

    Bitmark → JSON only: include unknown properties in the bit JSON (default: false). An unknown property ([@key:value] the bit's config cannot resolve, at the bit body/footer — never inside cards or consumed by a chain) is appended after all real keys as an array of strings ([@u] with no value → true); a key colliding with a configured key is _-prefixed. Unknown properties are never converted back to bitmark, and each occurrence still warns.

    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").

    mappingReport?: boolean

    Replace the converted output with a human-readable MAPPING REPORT of what each input construct mapped to — including inputs that are NOT mapped (default: false). Composite conversions (e.g. xml → json) report every leg, one section after the other.

    mode?: OutputMode

    JSON output mode (default: "optimized").

    outputFormat?: "auto" | OutputFormat

    Output format (default: "auto" — the opposite of the input).

    plainText?: boolean

    Output text as plain text — debug mode (default: false).

    positionEncoding?: PositionEncoding

    How positions are counted — "utf-16" code units (default; the LSP default, what browser editors index by) or "utf-8" bytes: the columns and lengths of "semantic-tokens" and "diagnostics" output, and the offsets of convertWithDetails' bitSpans. Echoed wherever it applies; ignored otherwise.

    pretty?: boolean

    Prettify the JSON being emitted (default: false). For JSON output this is the whole document; for bitmark output it is the embedded JSON bodies of json-format bits (cosmetic — they re-parse to the same value).

    spacesAroundValues?: number

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

    tokensLayout?: TokensLayout

    "semantic-tokens" output only: "lsp" (default) writes the relative data array, "absolute" one { line, start, length, type, modifiers } object per token. Ignored by every other output format.

    warnings?: boolean

    Include validation warnings in parser.warnings output (default: false).