Interface TerminalCompletionProvider<T>

A provider that supplies terminal completion items.

Implementations of this interface should return an array of TerminalCompletionItem or a TerminalCompletionList describing completions for the current command line.

Example: Simple provider returning a single completion

window.registerTerminalCompletionProvider('extension-provider-id', {
 provideTerminalCompletions(terminal, context) {
     return [{ label: '--help', replacementIndex: Math.max(0, context.cursorPosition - 2), replacementLength: 2 }];
 }
});

interface TerminalCompletionProvider<T extends TerminalCompletionItem> {
    provideTerminalCompletions(
        terminal: Terminal,
        context: TerminalCompletionContext,
        token: CancellationToken,
    ): ProviderResult<T[] | TerminalCompletionList<T>>;
}

Type Parameters

T extends TerminalCompletionItem

Index

Methods

provideTerminalCompletions

Methods

provideTerminalCompletions

provideTerminalCompletions(
    terminal: Terminal,
    context: TerminalCompletionContext,
    token: CancellationToken,
): ProviderResult<T[] | TerminalCompletionList<T>>
Provide completions for the given terminal and context.
Parameters
- terminal: Terminal
  The terminal for which completions are being provided.
- context: TerminalCompletionContext
  Information about the terminal's current state.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T[] | TerminalCompletionList<T>>
A list of completions.
- Defined in packages/plugin/src/theia.proposed.terminalCompletionProvider.d.ts:48

Interface TerminalCompletionProvider<T>

Example: Simple provider returning a single completion

Type Parameters

Index

Methods

Methods

provideTerminalCompletions

Parameters

Returns ProviderResult<T[] | TerminalCompletionList<T>>

Settings

On This Page