Interface TerminalLinkProvider<T>

A provider that enables detection and handling of links within terminals.

interface TerminalLinkProvider<T extends TerminalLink = TerminalLink> {
    handleTerminalLink(link: T): ProviderResult<void>;
    provideTerminalLinks(
        context: TerminalLinkContext,
        token: CancellationToken,
    ): ProviderResult<T[]>;
}

Type Parameters

T extends TerminalLink = TerminalLink

Index

Methods

handleTerminalLink provideTerminalLinks

Methods

handleTerminalLink

handleTerminalLink(link: T): ProviderResult<void>
Handle an activated terminal link.
Parameters
- link: T
  The link to handle.
Returns ProviderResult<void>
- Defined in packages/plugin/src/theia.d.ts:3851

provideTerminalLinks

provideTerminalLinks(
context: TerminalLinkContext,
token: CancellationToken,
): ProviderResult<T[]>
Provide terminal links for the given context. Note that this can be called multiple times even before previous calls resolve, make sure to not share global objects (eg. RegExp) that could have problems when asynchronous usage may overlap.
Parameters
- context: TerminalLinkContext
  Information about what links are being provided for.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T[]>
A list of terminal links for the given line.
- Defined in packages/plugin/src/theia.d.ts:3845