kotlin-vscode/vscode/LogOutputChannel

LogOutputChannel

interface LogOutputChannel : OutputChannel(source)

A channel for containing log output.

To get an instance of a LogOutputChannel use createOutputChannel.

Online Documentation

Properties

logLevel

abstract val logLevel: LogLevel

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

name

abstract val name: String

The human-readable name of this output channel.

onDidChangeLogLevel

abstract val onDidChangeLogLevel: Event<LogLevel>

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

Functions

append

abstract fun append(value: String)

Append the given value to the channel.

appendLine

abstract fun appendLine(value: String)

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

clear

abstract fun clear()

Removes all output from the channel.

debug

abstract fun debug(message: String, vararg args: JsAny?)

Outputs the given debug message to the channel.

dispose

abstract override fun dispose()

Dispose and free associated resources.

error

abstract fun error(error: JsError, vararg args: JsAny?)

abstract fun error(error: String, vararg args: JsAny?)

Outputs the given error or error message to the channel.

hide

abstract fun hide()

Hide this channel from the UI.

info

abstract fun info(message: String, vararg args: JsAny?)

Outputs the given information message to the channel.

replace

abstract fun replace(value: String)

Replaces all output from the channel with the given value.

show

abstract fun show(preserveFocus: Boolean = definedExternally)

Reveal this channel in the UI.

trace

abstract fun trace(message: String, vararg args: JsAny?)

Outputs the given trace message to the channel. Use this method to log verbose information.

warn

abstract fun warn(message: String, vararg args: JsAny?)

Outputs the given warning message to the channel.