An output channel is a container for readonly textual information.

To get an instance of an OutputChannel use {@link window.createOutputChannel createOutputChannel}.

Variables

name:String

The human-readable name of this output channel.

Methods

append(value:String):Void

Append the given value to the channel.

Parameters:

value

A string, falsy values will not be printed.

appendLine(value:String):Void

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

Parameters:

value

A string, falsy values will be printed.

clear():Void

Removes all output from the channel.

dispose():Void

Dispose and free associated resources.

hide():Void

Hide this channel from the UI.

replace(value:String):Void

Replaces all output from the channel with the given value.

Parameters:

value

A string, falsy values will not be printed.

show(?preserveFocus:Bool):Void

show(?column:ViewColumn, ?preservceFocus:Bool):Void

Reveal this channel in the UI.

Parameters:

preserveFocus

When true the channel will not take focus.