Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerminalLink

A link on a terminal line.

Hierarchy

  • TerminalLink

Index

Constructors

Properties

Constructors

constructor

  • new TerminalLink(startIndex: number, length: number, tooltip?: string): TerminalLink

  • Creates a new terminal link.

    Parameters

    • startIndex: number

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

    • length: number

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

    • Optional 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.

    Returns TerminalLink

Properties

length

length: number

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

startIndex

startIndex: number

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

Optional tooltip

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.