Class LogOutputChannelImpl

A channel for containing log output.

To get an instance of a LogOutputChannel use createOutputChannel.

Hierarchy (View Summary)

OutputChannelImpl
- LogOutputChannelImpl

Implements

LogOutputChannel

Index

Constructors

constructor

new LogOutputChannelImpl(
    name: string,
    proxy: OutputChannelRegistryMain,
    pluginInfo: PluginInfo,
): LogOutputChannelImpl
Parameters
- name: string
- proxy: OutputChannelRegistryMain
- pluginInfo: PluginInfo
Returns LogOutputChannelImpl
Overrides OutputChannelImpl.constructor
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:32

Properties

logLevel

logLevel: LogLevel

The current log level of the channel. Defaults to editor log level.

`Readonly`name

name: string

The name of this output channel.

`Readonly`onDidChangeLogLevel

onDidChangeLogLevel: Event<LogLevel> = ...

An Event which fires when the log level of the channel changes.

`Readonly`onDidChangeLogLevelEmitter

onDidChangeLogLevelEmitter: Emitter<LogLevel> = ...

`Protected` `Readonly`pluginInfo

pluginInfo: PluginInfo

`Protected` `Readonly`proxy

proxy: OutputChannelRegistryMain

Methods

append

append(value: string): void
Append the given value to the channel.
Parameters
- value: string
Returns void
Implementation of LogOutputChannel.append
Overrides OutputChannelImpl.append
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:48

appendLine

appendLine(value: string): void
Append the given value and a line feed character to the channel.
Parameters
- value: string
Returns void
Implementation of LogOutputChannel.appendLine
Overrides OutputChannelImpl.appendLine
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:53

clear

clear(): void
Removes all output from the channel.

Returns void
Implementation of LogOutputChannel.clear
Inherited from OutputChannelImpl.clear
- Defined in packages/plugin-ext/src/plugin/output-channel/output-channel-item.ts:50

debug

debug(message: string, ...args: any[]): void
Outputs the given debug message to the channel.

The message is only logged if the channel is configured to display debug log level or lower.
Parameters
- message: string
  debug message to log
- ...args: any[]
Returns void
Implementation of LogOutputChannel.debug
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:81

dispose

dispose(): void
Dispose and free associated resources.

Returns void
Implementation of LogOutputChannel.dispose
Overrides OutputChannelImpl.dispose
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:58

error

error(errorMsg: string | Error, ...args: any[]): void
Outputs the given error or error message to the channel.

The message is only logged if the channel is configured to display error log level or lower.
Parameters
- errorMsg: string | Error
- ...args: any[]
Returns void
Implementation of LogOutputChannel.error
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:93

getLogLevel

getLogLevel(): LogLevel
Returns LogLevel
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:44

hide

hide(): void
Hide this channel from the UI.

Returns void
Implementation of LogOutputChannel.hide
Inherited from OutputChannelImpl.hide
- Defined in packages/plugin-ext/src/plugin/output-channel/output-channel-item.ts:63

info

info(message: string, ...args: any[]): void
Outputs the given information message to the channel.

The message is only logged if the channel is configured to display info log level or lower.
Parameters
- message: string
  info message to log
- ...args: any[]
Returns void
Implementation of LogOutputChannel.info
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:85

`Protected`log

log(level: LogLevel, message: string): void
Parameters
- level: LogLevel
- message: string
Returns void
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:63

replace

replace(value: string): void
Replaces all output from the channel with the given value.
Parameters
- value: string
  A string, falsy values will not be printed.
Returns void
Implementation of LogOutputChannel.replace
Inherited from OutputChannelImpl.replace
- Defined in packages/plugin-ext/src/plugin/output-channel/output-channel-item.ts:44

setLogLevel

setLogLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:37

show

show(
preserveFocusOrColumn?: boolean | ViewColumn,
preserveFocus?: boolean,
): void
Reveal this channel in the UI.
Parameters
- OptionalpreserveFocusOrColumn: boolean | ViewColumn
  This argument is deprecated and will be ignored.
- OptionalpreserveFocus: boolean
  When true the channel will not take focus.
Returns void
Deprecated
Use the overload with just one parameter (show(preserveFocus?: boolean): void).
Implementation of LogOutputChannel.show
Inherited from OutputChannelImpl.show
- Defined in packages/plugin-ext/src/plugin/output-channel/output-channel-item.ts:55

trace

trace(message: string, ...args: any[]): void
Outputs the given trace message to the channel. Use this method to log verbose information.

The message is only logged if the channel is configured to display trace log level.
Parameters
- message: string
  trace message to log
- ...args: any[]
Returns void
Implementation of LogOutputChannel.trace
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:77

`Protected`validate

validate(): void
Returns void
Inherited from OutputChannelImpl.validate
- Defined in packages/plugin-ext/src/plugin/output-channel/output-channel-item.ts:68

warn

warn(message: string, ...args: any[]): void
Outputs the given warning message to the channel.

The message is only logged if the channel is configured to display warning log level or lower.
Parameters
- message: string
  warning message to log
- ...args: any[]
Returns void
Implementation of LogOutputChannel.warn
- Defined in packages/plugin-ext/src/plugin/output-channel/log-output-channel.ts:89

Class LogOutputChannelImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LogOutputChannelImpl

Properties

logLevel

Readonlyname

ReadonlyonDidChangeLogLevel

ReadonlyonDidChangeLogLevelEmitter

Protected ReadonlypluginInfo

Protected Readonlyproxy

Methods

append

Parameters

Returns void

appendLine

Parameters

Returns void

clear

Returns void

debug

Parameters

Returns void

dispose

Returns void

error

Parameters

Returns void

getLogLevel

Returns LogLevel

hide

Returns void

info

Parameters

Returns void

Protectedlog

Parameters

Returns void

replace

Parameters

Returns void

setLogLevel

Parameters

Returns void

show

Parameters

Returns void

Deprecated

trace

Parameters

Returns void

Protectedvalidate

Returns void

warn

Parameters

Returns void

Settings

On This Page

`Readonly`name

`Readonly`onDidChangeLogLevel

`Readonly`onDidChangeLogLevelEmitter

`Protected` `Readonly`pluginInfo

`Protected` `Readonly`proxy

`Protected`log

`Protected`validate