A channel for containing log output.
To get an instance of a LogOutputChannel
use
{@link window.createOutputChannel createOutputChannel}.
A channel for containing log output. To get an instance of a `LogOutputChannel` use {@link window.createOutputChannel createOutputChannel}.
(append log-output-channel value)
Append the given value to the channel.
Parameters:
value
: string
- A string, falsy values will not be printed.Returns: void
Append the given value to the channel. **Parameters:** - `value`: `string` - A string, falsy values will not be printed. **Returns:** `void`
(append-line log-output-channel value)
Append the given value and a line feed character to the channel.
Parameters:
value
: string
- A string, falsy values will be printed.Returns: void
Append the given value and a line feed character to the channel. **Parameters:** - `value`: `string` - A string, falsy values will be printed. **Returns:** `void`
(clear log-output-channel)
Removes all output from the channel.
Returns: void
Removes all output from the channel. **Returns:** `void`
(debug log-output-channel message & args)
Outputs the given debug message to the channel.
The message is only logged if the channel is configured to display {@link LogLevel.Debug debug} log level or lower.
Parameters:
message
: string
- debug message to logargs
: any[]
Returns: void
Outputs the given debug message to the channel. The message is only logged if the channel is configured to display {@link LogLevel.Debug debug} log level or lower. **Parameters:** - `message`: `string` - debug message to log - `args`: `any[]` **Returns:** `void`
(dispose log-output-channel)
Dispose and free associated resources.
Returns: void
Dispose and free associated resources. **Returns:** `void`
(error log-output-channel error & args)
Outputs the given error or error message to the channel.
The message is only logged if the channel is configured to display {@link LogLevel.Error error} log level or lower.
Parameters:
error
: string | Error
- Error or error message to logargs
: any[]
Returns: void
Outputs the given error or error message to the channel. The message is only logged if the channel is configured to display {@link LogLevel.Error error} log level or lower. **Parameters:** - `error`: `string | Error` - Error or error message to log - `args`: `any[]` **Returns:** `void`
(hide log-output-channel)
Hide this channel from the UI.
Returns: void
Hide this channel from the UI. **Returns:** `void`
(info log-output-channel message & args)
Outputs the given information message to the channel.
The message is only logged if the channel is configured to display {@link LogLevel.Info info} log level or lower.
Parameters:
message
: string
- info message to logargs
: any[]
Returns: void
Outputs the given information message to the channel. The message is only logged if the channel is configured to display {@link LogLevel.Info info} log level or lower. **Parameters:** - `message`: `string` - info message to log - `args`: `any[]` **Returns:** `void`
(log-level log-output-channel)
The current log level of the channel. Defaults to {@link env.logLevel editor log level}.
Returns: LogLevel
The current log level of the channel. Defaults to {@link env.logLevel editor log level}. **Returns:** `LogLevel`
(name log-output-channel)
The human-readable name of this output channel.
Returns: string
The human-readable name of this output channel. **Returns:** `string`
(on-did-change-log-level log-output-channel)
(on-did-change-log-level log-output-channel listener)
(on-did-change-log-level log-output-channel listener this-args)
(on-did-change-log-level log-output-channel listener this-args disposables)
An {@link Event } which fires when the log level of the channel changes.
Parameters:
listener
: (e: T) => any
- The listener function will be called when the event happens.this-args
: any
- The this
-argument which will be used when calling the event listener.disposables
: Disposable[] | undefined
- An array to which a {@link Disposable } will be added.Returns: Disposable
- A disposable which unsubscribes the event listener.
An {@link Event } which fires when the log level of the channel changes. **Parameters:** - `listener`: `(e: T) => any` - The listener function will be called when the event happens. - `this-args`: `any` - The `this`-argument which will be used when calling the event listener. - `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added. **Returns:** `Disposable` - A disposable which unsubscribes the event listener.
(replace log-output-channel value)
Replaces all output from the channel with the given value.
Parameters:
value
: string
- A string, falsy values will not be printed.Returns: 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 log-output-channel)
(show log-output-channel column)
(show log-output-channel preserve-focus?)
(show log-output-channel column preserve-focus?)
Reveal this channel in the UI.
Parameters:
column
: ViewColumn | undefined
- This argument is deprecated and will be ignored.preserve-focus?
: boolean | undefined
- When true
the channel will not take focus.Returns: void
Reveal this channel in the UI. **Parameters:** - `column`: `ViewColumn | undefined` - This argument is **deprecated** and will be ignored. - `preserve-focus?`: `boolean | undefined` - When `true` the channel will not take focus. **Returns:** `void`
(trace log-output-channel message & args)
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 {@link LogLevel.Trace trace} log level.
Parameters:
message
: string
- trace message to logargs
: any[]
Returns: 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 {@link LogLevel.Trace trace} log level. **Parameters:** - `message`: `string` - trace message to log - `args`: `any[]` **Returns:** `void`
(warn log-output-channel message & args)
Outputs the given warning message to the channel.
The message is only logged if the channel is configured to display {@link LogLevel.Warning warning} log level or lower.
Parameters:
message
: string
- warning message to logargs
: any[]
Returns: void
Outputs the given warning message to the channel. The message is only logged if the channel is configured to display {@link LogLevel.Warning warning} log level or lower. **Parameters:** - `message`: `string` - warning message to log - `args`: `any[]` **Returns:** `void`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close