Interface ProvidedTerminalLink

A link on a terminal line.

interface ProvidedTerminalLink {
    length: number;
    providerId: string;
    startIndex: number;
    tooltip?: string;
}

Hierarchy (view full)

Properties

length: number

The length of the link on [TerminalLinkContext.line](#TerminalLinkContext.line]

providerId: string
startIndex: number

The start index of the link on [TerminalLinkContext.line](#TerminalLinkContext.line].

tooltip?: string

The tooltip text when you hover over this link.

If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.