Interface OutputChannel

An output channel is a container for readonly textual information.

To get an instance of an OutputChannel use createOutputChannel.

Hierarchy

OutputChannel
- LogOutputChannel

Index

Properties

name

Methods

Properties

Readonly name

name: string

The name of this output channel.

Methods

append

append(value: string): void

- Defined in packages/plugin/src/theia.d.ts:2723
Append the given value to the channel.

Parameters
- value: string
Returns void

appendLine

appendLine(value: string): void

- Defined in packages/plugin/src/theia.d.ts:2731
Append the given value and a line feed character to the channel.

Parameters
- value: string
Returns void

clear

clear(): void

- Defined in packages/plugin/src/theia.d.ts:2743
Removes all output from the channel.

Returns void

dispose

dispose(): void

- Defined in packages/plugin/src/theia.d.ts:2770
Dispose and free associated resources.

Returns void

hide

hide(): void

- Defined in packages/plugin/src/theia.d.ts:2765
Hide this channel from the UI.

Returns void

replace

replace(value: string): void

- Defined in packages/plugin/src/theia.d.ts:2738
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?: ViewColumn, preserveFocus?: boolean): void
show(preserveFocus?: boolean): void

- Defined in packages/plugin/src/theia.d.ts:2753
Reveal this channel in the UI.

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

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
- Defined in packages/plugin/src/theia.d.ts:2760
Reveal this channel in the UI.

Parameters
- Optional preserveFocus: boolean
  
  When true the channel will not take focus.
Returns void