`TypeshadeHover`

Interface in Editor

Hover documentation and source span returned by the language layer.

import type { TypeshadeHover } from 'typeshade'

The signature, the description and the examples come from the compiler's own source at commit 26de7be8.

Syntax

interface TypeshadeHover {
  readonly contents: readonly string[];
  readonly span: TypeshadeTextSpan;
  readonly range: TypeshadeRange;
}

contentsread only readonly string[]: Rendered hover content, one entry per section.
spanread only TypeshadeTextSpan: UTF-16 offset span the hover documents.
rangeread only TypeshadeRange: Zero-based half-open range the hover documents, equivalent to span.