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

    Function hover

    • The construct at position in bitmark source, as an LSP Hover (PLAN-196): the bit type, a tag in its scope (with the same record info({ infoType: "bit", full: true }) shows for it there), a tag value, a header resource type, an inline attribute key or value. contents is Markdown; data carries the record it was rendered from. null on body text, dividers and whitespace.

      Parameters

      • input: string

        Bitmark source text.

      • position: Position

        0-based line / character in positionEncoding units.

      • options: HoverOptions = {}

        positionEncoding ("utf-16", the default, or "utf-8").

      Returns Hover | null

      A Hover, or null.

      UnsupportedFeatureError on a variant built without editor; an error when position.line is past the end of the text, or when the input is a JSON document (there is no bitmark source to resolve a position in).