Theia API Documentation v1.65.0
    Preparing search index...

    Interface TerminalServiceMain

    interface TerminalServiceMain {
        $createTerminal(
            id: string,
            options: TerminalOptions,
            parentId?: string,
            isPseudoTerminal?: boolean,
        ): Promise<string>;
        $dispose(id: string): void;
        $disposeByTerminalId(id: number, waitOnExit?: string | boolean): void;
        $hide(id: string): void;
        $hideByTerminalId(id: number): void;
        $registerTerminalLinkProvider(providerId: string): Promise<void>;
        $registerTerminalObserver(
            id: string,
            nrOfLinesToMatch: number,
            outputMatcherRegex: string,
        ): unknown;
        $resize(id: string, cols: number, rows: number): void;
        $resizeByTerminalId(id: number, cols: number, rows: number): void;
        $sendText(id: string, text: string, shouldExecute?: boolean): void;
        $sendTextByTerminalId(id: number, text: string, addNewLine?: boolean): void;
        $setEnvironmentVariableCollection(
            persistent: boolean,
            extensionIdentifier: string,
            rootUri: string,
            collection: SerializableEnvironmentVariableCollection,
        ): void;
        $setName(id: string, name: string): void;
        $setNameByTerminalId(id: number, name: string): void;
        $show(id: string, preserveFocus?: boolean): void;
        $showByTerminalId(id: number, preserveFocus?: boolean): void;
        $unregisterTerminalLinkProvider(providerId: string): Promise<void>;
        $unregisterTerminalObserver(id: string): unknown;
        $write(id: string, data: string): void;
        $writeByTerminalId(id: number, data: string): void;
    }

    Implemented by

    Index

    Methods

    $createTerminal $dispose $disposeByTerminalId $hide $hideByTerminalId $registerTerminalLinkProvider $registerTerminalObserver $resize $resizeByTerminalId $sendText $sendTextByTerminalId $setEnvironmentVariableCollection $setName $setNameByTerminalId $show $showByTerminalId $unregisterTerminalLinkProvider $unregisterTerminalObserver $write $writeByTerminalId

    Methods

    • Create new Terminal with Terminal options.

      Parameters

      • id: string
      • options: TerminalOptions

        object with parameters to create new terminal.

      • OptionalparentId: string
      • OptionalisPseudoTerminal: boolean

      Returns Promise<string>

    • Destroy terminal.

      Parameters

      • id: number

        terminal id.

      • OptionalwaitOnExit: string | boolean

        Whether to wait for a key press before closing the terminal.

      Returns void

    • Register a new terminal link provider.

      Parameters

      • providerId: string

        id of the terminal link provider to be registered.

      Returns Promise<void>

    • Register a new terminal observer.

      Parameters

      • id: string
      • nrOfLinesToMatch: number

        the number of lines to match the outputMatcherRegex against

      • outputMatcherRegex: string

        the regex to match the output to

      Returns unknown

    • Send text to the terminal by id.

      Parameters

      • id: string

        terminal widget id.

      • text: string

        text content.

      • OptionalshouldExecute: boolean

        in case true - Indicates that the text being sent should be executed rather than just inserted in the terminal.

      Returns void

    • Send text to the terminal by id.

      Parameters

      • id: number

        terminal id.

      • text: string

        text content.

      • OptionaladdNewLine: boolean

        in case true - add new line after the text, otherwise - don't apply new line.

      Returns void

    • Show terminal on the UI panel.

      Parameters

      • id: string

        terminal widget id.

      • OptionalpreserveFocus: boolean

        set terminal focus in case true value, and don't set focus otherwise.

      Returns void

    • Show terminal on the UI panel.

      Parameters

      • id: number

        terminal id.

      • OptionalpreserveFocus: boolean

        set terminal focus in case true value, and don't set focus otherwise.

      Returns void

    • Unregister the terminal link provider with the specified id.

      Parameters

      • providerId: string

        id of the terminal link provider to be unregistered.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods