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): void;
    appendLine(value): void;
    clear(): void;
    dispose(): void;
    hide(): void;
    replace(value): void;
    show(column?, preserveFocus?): void;
    show(preserveFocus?): void;
}

Hierarchy (view full)

Implemented by

Properties

name

Methods

append appendLine clear dispose hide replace show

Properties

Readonly name

name: string

The name of this output channel.

Methods

append

appendLine

clear

dispose

hide

replace

  • replace(value): void

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

    Parameters

    • value: string

      A string, falsy values will not be printed.

    Returns void

show

  • show(column?, preserveFocus?): void

  • Reveal this channel in the UI.

    Parameters

    • Optional column: ViewColumn

      This argument is deprecated and will be ignored.

    • Optional preserveFocus: boolean

      When true the channel will not take focus.

    Returns void

    Deprecated

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

  • show(preserveFocus?): void

  • Reveal this channel in the UI.

    Parameters

    • Optional preserveFocus: boolean

      When true the channel will not take focus.

    Returns void

Settings

Member Visibility

Theme

On This Page

nameappendappendLinecleardisposehidereplaceshow