outputAPI
MS Code Extension API / core/extensionAPI/modules/window/outputAPI
core/extensionAPI/modules/window/outputAPI
Functions
createOutputAPI()
createOutputAPI():
object
Defined in: core/extensionAPI/modules/window/outputAPI.ts:8
Returns
createOutputChannel
createOutputChannel: (
name) =>object
Creates a new output channel with a specific name.
Parameters
name
string
The display name of the channel.
Returns
object
An object representing the output channel with control methods.
append
append: (
text) =>void
Parameters
text
string
Returns
void
appendLine
appendLine: (
text) =>void
Parameters
text
string
Returns
void
clear
clear: () =>
void
Returns
void
clearKillHandler
clearKillHandler: () =>
void
Returns
void
dispose
dispose: () =>
void
Returns
void
name
name:
string
onDidKill
onDidKill: (
handler) =>void
Parameters
handler
() => void
Returns
void
show
show: () =>
void
Returns
void
onDidChangeActiveOutputChannel
onDidChangeActiveOutputChannel: (
handler) =>object
Fired when the active output channel changes.
Parameters
handler
(channelName) => void
Callback receiving the name of the newly active channel.
Returns
object
A disposable object to stop listening.
dispose
dispose: () =>
void
Returns
void
onDidCloseOutputChannel
onDidCloseOutputChannel: (
handler) =>object
Fired when an output channel is disposed/closed.
Parameters
handler
(channelName) => void
Callback receiving the name of the closed channel.
Returns
object
A disposable object to stop listening.
dispose
dispose: () =>
void
Returns
void
onDidOpenOutputChannel
onDidOpenOutputChannel: (
handler) =>object
Fired when a new output channel is created.
Parameters
handler
(channelName) => void
Callback receiving the name of the new channel.
Returns
object
A disposable object to stop listening.
dispose
dispose: () =>
void
Returns
void
activeOutputChannel
Get Signature
get activeOutputChannel():
string
Returns the name of the currently active output channel.
Returns
string
The active channel name.
outputChannels
Get Signature
get outputChannels():
string[]
Returns a list of all currently open output channels.
Returns
string[]
Array of channel names.