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

    Interface OutputChannel

    An output channel is a container for readonly textual information.

    To get an instance of an OutputChannel use createOutputChannel.

    interface OutputChannel {
        name: string;
        append(value: string): void;
        appendLine(value: string): void;
        clear(): void;
        dispose(): void;
        hide(): void;
        replace(value: string): void;
        show(column?: ViewColumn, preserveFocus?: boolean): void;
        show(preserveFocus?: boolean): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    name

    Methods

    append appendLine clear dispose hide replace show

    Properties

    name: string

    The name of this output channel.

    Methods

    • Append the given value and a line feed character to the channel.

      Parameters

      • value: string

      Returns void

    • Replaces all output from the channel with the given value.

      Parameters

      • value: string

        A string, falsy values will not be printed.

      Returns void

    • Reveal this channel in the UI.

      Parameters

      • Optionalcolumn: ViewColumn

        This argument is deprecated and will be ignored.

      • OptionalpreserveFocus: boolean

        When true the channel will not take focus.

      Returns void

      Use the overload with just one parameter (show(preserveFocus?: boolean): void).

    • Reveal this channel in the UI.

      Parameters

      • OptionalpreserveFocus: boolean

        When true the channel will not take focus.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods