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

    Interface InfoOptions

    Options for the info function.

    interface InfoOptions {
        bit?: string;
        format?: InfoFormat;
        full?: boolean;
        includeDeprecated?: boolean;
        indent?: number;
        infoType?: InfoType;
        language?: string | readonly string[];
        onlyDeprecated?: boolean;
        pretty?: boolean;
    }
    Index
    bit?: string

    Bit name — required when infoType is "bit".

    format?: InfoFormat

    Output format (default: "text").

    full?: boolean

    Full detail for "bit"/"all": provenance, keys, card structure (default false = compact one-line-per-tag view).

    includeDeprecated?: boolean

    Include deprecated bits in list/all output (default: false).

    indent?: number

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

    infoType?: InfoType

    Info query type (default: "list").

    language?: string | readonly string[]

    BCP-47 language tag(s) for DISPLAY NAMES — title on bits, bit groups and resource groups. Default (or "") is English.

    Accepts one tag ("de"), several (["de", "fr"] or "de,fr"), or ALL_LANGUAGES for every language this build can resolve — see info({ infoType: "languages" }).

    More than one language adds a titles map to each result, so a consumer building a multilingual index makes ONE call instead of one per language. A single tag renders exactly as it always did, with no titles.

    Resolution narrows one subtag at a time (de-CHde), then falls back to the English title, then to the technical key. A partially translated language is therefore safe: untranslated entries stay English rather than emptying out. Technical identity — name, key — is never translated.

    Which translations are available depends on the variant and on register: the full wasm bakes a table in, the lean variants start empty and expect you to register one.

    onlyDeprecated?: boolean

    Restrict list/all output to deprecated bits only (default: false; wins over includeDeprecated).

    pretty?: boolean

    Whether to pretty-print JSON output (default: false).