d/vscode
library
Classes
$ModuleAuthentication
$ModuleCommands
$ModuleDebug
$ModuleEnv
$ModuleExtensions
$ModuleL10n
$ModuleLanguages
$ModuleNotebooks
$ModuleScm
$ModuleTasks
$ModuleTests
$ModuleVscode
$ModuleWindow
$ModuleWorkspace
AccessibilityInformation
Accessibility information which controls screen reader behavior.
AuthenticationForceNewSessionOptions
Optional options to be used when calling {@link authentication.getSession} with the flag forceNewSession.
AuthenticationGetSessionOptions
Options to be used when getting an {@link AuthenticationSession} from an {@link AuthenticationProvider}.
AuthenticationProvider
A provider for performing authentication to a service.
AuthenticationProviderAuthenticationSessionsChangeEvent
An {@link Event} which fires when an {@link AuthenticationSession} is added, removed, or changed.
AuthenticationProviderInformation
Basic information about an {@link AuthenticationProvider}
AuthenticationProviderOptions
Options for creating an {@link AuthenticationProvider}.
AuthenticationSession
Represents a session of a currently logged in user.
AuthenticationSessionAccountInformation
The information of an account associated with an {@link AuthenticationSession}.
AuthenticationSessionsChangeEvent
An {@link Event} which fires when an {@link AuthenticationSession} is added, removed, or changed.
AutoClosingPair
Describes pairs of strings where the close string will be automatically inserted when typing the opening string.
Breakpoint
The base class of all breakpoint types.
BreakpointsChangeEvent
An event describing the changes to the set of {@link Breakpointbreakpoints}.
Buffer
CallHierarchyIncomingCall
Represents an incoming call, e.g. a caller of a method or constructor.
CallHierarchyItem
Represents programming constructs like functions or constructors in the context
of call hierarchy.
CallHierarchyOutgoingCall
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
CallHierarchyProvider
The call hierarchy provider interface describes the contract between extensions
and the call hierarchy feature which allows to browse calls and caller of function,
methods, constructor etc.
CancellationError
An error type that should be used to signal cancellation of an operation.
CancellationToken
A cancellation token is passed to an asynchronous or long running
operation to request cancellation, like cancelling a request
for completion items because the user continued to type.
CancellationTokenSource
A cancellation source creates and controls a {@link CancellationTokencancellation token}.
ChildProcess
Clipboard
The clipboard provides read and write access to the system's clipboard.
CodeAction
A code action represents a change that can be performed in code, e.g. to fix a problem or
to refactor code.
CodeActionContext
Contains additional diagnostic information about the context in which
a {@link CodeActionProvider.provideCodeActionscode action} is run.
CodeActionKind
Kind of a code action.
CodeActionProvider <T extends CodeAction >
Provides contextual actions for code. Code actions typically either fix problems or beautify/refactor code.
CodeActionProviderMetadata
Metadata about the type of code actions that a {@link CodeActionProvider} provides.
CodeLens
A code lens represents a {@link Command} that should be shown along with
source text, like the number of references, a way to run tests, etc.
CodeLensProvider <T extends CodeLens >
A code lens provider adds {@link Commandcommands} to source text. The commands will be shown
as dedicated horizontal lines in between the source text.
Color
Represents a color in RGBA space.
ColorInformation
Represents a color range from a document.
ColorPresentation
A color presentation object describes how a {@linkcode Color} should be represented as text and what
edits are required to refer to it from source code.
ColorTheme
Represents a color theme.
Command
Represents a reference to a command. Provides a title which
will be used to represent a command in the UI and, optionally,
an array of arguments which will be passed to the command handler
function when invoked.
A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
Author information of a {@link Comment}
A comment controller is able to provide {@link CommentThreadcomments} support to the editor and
provide users various ways to interact with comments.
Commenting range provider for a {@link CommentControllercomment controller}.
Represents a {@link CommentControllercomment controller}'s {@link CommentController.optionsoptions}.
Reactions of a {@link Comment}
Command argument for actions registered in comments/commentThread/context.
Describes how comments for a language work.
A collection of {@link Commentcomments} representing a conversation at a particular range in a document.
CompletionContext
Contains additional information about the context in which
{@link CompletionItemProvider.provideCompletionItemscompletion provider} is triggered.
CompletionItem
A completion item represents a text snippet that is proposed to complete text that is being typed.
CompletionItemLabel
A structured label for a {@link CompletionItemcompletion item}.
CompletionItemProvider <T extends CompletionItem >
The completion item provider interface defines the contract between extensions and
IntelliSense .
CompletionList <T extends CompletionItem >
Represents a collection of {@link CompletionItemcompletion items} to be presented
in the editor.
ConfigurationChangeEvent
An event describing the change in Configuration
CustomDocument
Represents a custom document used by a {@linkcode CustomEditorProvider}.
CustomDocumentBackup
A backup for an {@linkcode CustomDocument}.
CustomDocumentBackupContext
Additional information used to implement {@linkcode CustomDocumentBackup}.
CustomDocumentContentChangeEvent <T extends CustomDocument >
Event triggered by extensions to signal to the editor that the content of a {@linkcode CustomDocument}
has changed.
CustomDocumentEditEvent <T extends CustomDocument >
Event triggered by extensions to signal to the editor that an edit has occurred on an {@linkcode CustomDocument}.
CustomDocumentOpenContext
Additional information about the opening custom document.
CustomEditorProvider <T extends CustomDocument >
Provider for editable custom editors that use a custom document model.
CustomExecution
Class used to execute an extension callback as a task.
CustomReadonlyEditorProvider <T extends CustomDocument >
Provider for readonly custom editors that use a custom document model.
CustomTextEditorProvider
Provider for text based custom editors.
DataTransfer
A map containing a mapping of the mime type of the corresponding transferred data.
DataTransferFile
A file associated with a {@linkcode DataTransferItem}.
DataTransferItem
Encapsulates data transferred during drag and drop operations.
DebugAdapter
A debug adapter that implements the Debug Adapter Protocol can be registered with the editor if it implements the DebugAdapter interface.
DebugAdapterDescriptorFactory
A debug adaper factory that creates {@link DebugAdapterDescriptordebug adapter descriptors}.
DebugAdapterExecutable
Represents a debug adapter executable and optional arguments and runtime options passed to it.
DebugAdapterExecutableOptions
Options for a debug adapter executable.
DebugAdapterInlineImplementation
A debug adapter descriptor for an inline implementation.
DebugAdapterNamedPipeServer
Represents a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
DebugAdapterServer
Represents a debug adapter running as a socket based server.
DebugAdapterTracker
A Debug Adapter Tracker is a means to track the communication between the editor and a Debug Adapter.
DebugAdapterTrackerFactory
A debug adaper factory that creates {@link DebugAdapterTrackerdebug adapter trackers}.
DebugConfiguration
Configuration for a debug session.
DebugConfigurationProvider
A debug configuration provider allows to add debug configurations to the debug service
and to resolve launch configurations before they are used to start a debug session.
A debug configuration provider is registered via {@link debug.registerDebugConfigurationProvider}.
DebugConsole
Represents the debug console.
DebugProtocolBreakpoint
A DebugProtocolBreakpoint is an opaque stand-in type for the Breakpoint type defined in the Debug Adapter Protocol.
DebugProtocolMessage
A DebugProtocolMessage is an opaque stand-in type for the ProtocolMessage type defined in the Debug Adapter Protocol.
DebugProtocolSource
A DebugProtocolSource is an opaque stand-in type for the Source type defined in the Debug Adapter Protocol.
DebugSession
A debug session.
DebugSessionCustomEvent
A custom Debug Adapter Protocol event received from a {@link DebugSessiondebug session}.
DebugSessionOptions
Options for {@link debug.startDebuggingstarting a debug session}.
DeclarationProvider
The declaration provider interface defines the contract between extensions and
the go to declaration feature.
DecorationInstanceRenderOptions
Represents render options for decoration instances. See {@link DecorationOptions.renderOptions}.
DecorationOptions
Represents options for a specific decoration in a {@link TextEditorDecorationTypedecoration set}.
DecorationRenderOptions
Represents rendering styles for a {@link TextEditorDecorationTypetext editor decoration}.
DefinitionProvider
The definition provider interface defines the contract between extensions and
the go to definition
and peek definition features.
Diagnostic
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
are only valid in the scope of a file.
DiagnosticChangeEvent
The event that is fired when diagnostics change.
DiagnosticCollection
A diagnostics collection is a container that manages a set of
{@link Diagnosticdiagnostics}. Diagnostics are always scopes to a
diagnostics collection and a resource.
DiagnosticRelatedInformation
Represents a related message and source code location for a diagnostic. This should be
used to point to code locations that cause or related to a diagnostics, e.g. when duplicating
a symbol in a scope.
Disposable
Represents a type which can release resources, such
as event listening or a timer.
DocumentColorProvider
The document color provider defines the contract between extensions and feature of
picking and modifying colors in the editor.
DocumentDropEdit
An edit operation applied {@link DocumentDropEditProvideron drop}.
DocumentDropEditProvider
Provider which handles dropping of resources into a text editor.
DocumentFilter
A document filter denotes a document by different properties like
the {@link TextDocument.languageIdlanguage}, the {@link Uri.schemescheme} of
its resource, or a glob-pattern that is applied to the {@link TextDocument.fileNamepath}.
DocumentFormattingEditProvider
The document formatting provider interface defines the contract between extensions and
the formatting-feature.
DocumentHighlight
A document highlight is a range inside a text document which deserves
special attention. Usually a document highlight is visualized by changing
the background color of its range.
DocumentHighlightProvider
The document highlight provider interface defines the contract between extensions and
the word-highlight-feature.
DocumentLink
A document link is a range in a text document that links to an internal or external resource, like another
text document or a web site.
DocumentLinkProvider <T extends DocumentLink >
The document link provider defines the contract between extensions and feature of showing
links in the editor.
DocumentRangeFormattingEditProvider
The document formatting provider interface defines the contract between extensions and
the formatting-feature.
DocumentRangeSemanticTokensProvider
The document range semantic tokens provider interface defines the contract between extensions and
semantic tokens.
DocumentSemanticTokensProvider
The document semantic tokens provider interface defines the contract between extensions and
semantic tokens.
DocumentSymbol
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document
symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to
its most interesting range, e.g. the range of an identifier.
DocumentSymbolProvider
The document symbol provider interface defines the contract between extensions and
the go to symbol -feature.
DocumentSymbolProviderMetadata
Metadata about a document symbol provider.
EnterAction
Describes what to do when pressing Enter.
Env
EnvironmentVariableCollection
A collection of mutations that an extension can apply to a process environment.
EnvironmentVariableMutator
A type of mutation and its value to be applied to an environment variable.
EnvironmentVariableMutatorOptions
Options applied to the mutator.
EnvironmentVariableScope
The scope object to which the environment variable collection applies.
EvaluatableExpression
An EvaluatableExpression represents an expression in a document that can be evaluated by an active debugger or runtime.
The result of this evaluation is shown in a tooltip-like widget.
If only a range is specified, the expression will be extracted from the underlying document.
An optional expression can be used to override the extracted expression.
In this case the range is still used to highlight the range in the document.
EvaluatableExpressionProvider
The evaluatable expression provider interface defines the contract between extensions and
the debug hover. In this contract the provider returns an evaluatable expression for a given position
in a document and the editor evaluates this expression in the active debug session and shows the result in a debug hover.
Event <T >
Represents a typed event.
EventEmitter <T >
An event emitter can be used to create and manage an {@link Event} for others
to subscribe to. One emitter always owns one event.
Extension <T >
Represents an extension.
ExtensionContext
An extension context is a collection of utilities private to an
extension.
ExtensionTerminalOptions
Value-object describing what options a virtual process terminal should use.
FileChangeEvent
The event filesystem providers must use to signal a file change.
FileCreateEvent
An event that is fired after files are created.
FileDecoration
A file decoration represents metadata that can be rendered with a file.
FileDecorationProvider
The decoration provider interfaces defines the contract between extensions and
file decorations.
FileDeleteEvent
An event that is fired after files are deleted.
FileRenameEvent
An event that is fired after files are renamed.
FileStat
The FileStat-type represents metadata about a file
FileSystem
The file system interface exposes the editor's built-in and contributed
{@link FileSystemProviderfile system providers}. It allows extensions to work
with files from the local disk as well as files from remote places, like the
remote extension host or ftp-servers.
FileSystemError
A type that filesystem providers should use to signal errors.
FileSystemProvider
The filesystem provider defines what the editor needs to read, write, discover,
and to manage files and folders. It allows extensions to serve files from remote places,
like ftp-servers, and to seamlessly integrate those into the editor.
FileSystemWatcher
A file system watcher notifies about changes to files and folders
on disk or from other {@link FileSystemProviderFileSystemProviders}.
FileWillCreateEvent
An event that is fired when files are going to be created.
FileWillDeleteEvent
An event that is fired when files are going to be deleted.
FileWillRenameEvent
An event that is fired when files are going to be renamed.
FoldingContext
Folding context (for future use)
FoldingRange
A line based folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document.
Invalid ranges will be ignored.
FoldingRangeProvider
The folding range provider interface defines the contract between extensions and
Folding in the editor.
FormattingOptions
Value-object describing what options formatting should use.
FunctionBreakpoint
A breakpoint specified by a function name.
GlobalEnvironmentVariableCollection
A collection of mutations that an extension can apply to a process environment. Applies to all scopes.
Hover
A hover represents additional information for a symbol or word. Hovers are
rendered in a tooltip-like widget.
HoverProvider
The hover provider interface defines the contract between extensions and
the hover -feature.
IInline0
IInline1
IInline11
IInline12
IInline13
IInline14
IInline19
IInline2
IInline20
IInline21
IInline22
IInline23
IInline24
IInline25
IInline26
IInline27
IInline28
IInline29
IInline3
IInline30 <T >
IInline31
IInline32
IInline33
IInline35
IInline37
IInline38
IInline39
IInline4
IInline40
IInline41
IInline42
IInline43
IInline44
IInline45
IInline46
IInline47
IInline48
IInline49
IInline5
IInline50
IInline51
IInline52
IInline53
IInline54
IInline55
IInline56
IInline58
IInline59
IInline6
IInline60
IInline61
IInline62
IInline63
IInline64
IInline65
IInline66
IInline67
IInline68
IInline7
IInline73
IInline74
IInline8
IInline81
IInline83
IInline84
IInline85
ImplementationProvider
The implementation provider interface defines the contract between extensions and
the go to implementation feature.
IndentationRule
Describes indentation rules for a language.
InlayHint
Inlay hint information.
InlayHintLabelPart
An inlay hint label part allows for interactive and composite labels of inlay hints.
InlayHintsProvider <T extends InlayHint >
The inlay hints provider interface defines the contract between extensions and
the inlay hints feature.
InlineCompletionContext
Provides information about the context in which an inline completion was requested.
InlineCompletionItem
An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
InlineCompletionItemProvider
The inline completion item provider interface defines the contract between extensions and
the inline completion feature.
InlineCompletionList
Represents a collection of {@link InlineCompletionIteminline completion items} to be presented
in the editor.
InlineValueContext
A value-object that contains contextual information when requesting inline values from a InlineValuesProvider.
InlineValueEvaluatableExpression
Provide an inline value through an expression evaluation.
If only a range is specified, the expression will be extracted from the underlying document.
An optional expression can be used to override the extracted expression.
InlineValuesProvider
The inline values provider interface defines the contract between extensions and the editor's debugger inline values feature.
In this contract the provider returns inline value information for a given document range
and the editor shows this information in the editor at the end of lines.
InlineValueText
Provide inline value as text.
InlineValueVariableLookup
Provide inline value through a variable lookup.
If only a range is specified, the variable name will be extracted from the underlying document.
An optional variable name can be used to override the extracted name.
InputBox
A concrete {@link QuickInput} to let the user input a text value.
InputBoxOptions
Options to configure the behavior of the input box UI.
InputBoxValidationMessage
Object to configure the behavior of the validation message.
LanguageConfiguration
The language configuration interfaces defines the contract between extensions
and various editor features, like automatic bracket insertion, automatic indentation etc.
LanguageStatusItem
A language status item is the preferred way to present language status reports for the active text editors,
such as selected linter or notifying about a configuration problem.
LightDarkPath
LinkedEditingRangeProvider
The linked editing range provider interface defines the contract between extensions and
the linked editing feature.
LinkedEditingRanges
Represents a list of ranges that can be edited together along with a word pattern to describe valid range contents.
Location
Represents a location inside a resource, such as a line
inside a text file.
LocationLink
Represents the connection of two locations. Provides additional metadata over normal {@link Locationlocations},
including an origin range.
LogOutputChannel
A channel for containing log output.
MarkdownString
Human-readable text that supports formatting via the markdown syntax .
Memento
A memento represents a storage utility. It can store and retrieve
values.
MessageItem
Represents an action that is shown with an information, warning, or
error message.
MessageOptions
Options to configure the behavior of the message.
Module
ModuleExports
NotebookCell
Represents a cell of a {@link NotebookDocumentnotebook}, either a {@link NotebookCellKind.Codecode}-cell
or {@link NotebookCellKind.Markupmarkup}-cell.
NotebookCellData
NotebookCellData is the raw representation of notebook cells. Its is part of {@linkcode NotebookData}.
NotebookCellExecution
A NotebookCellExecution is how {@link NotebookControllernotebook controller} modify a notebook cell as
it is executing.
NotebookCellExecutionSummary
The summary of a notebook cell execution.
NotebookCellOutput
Notebook cell output represents a result of executing a cell. It is a container type for multiple
{@link NotebookCellOutputItemoutput items} where contained items represent the same result but
use different MIME types.
NotebookCellOutputItem
One representation of a {@link NotebookCellOutputnotebook output}, defined by MIME type and data.
NotebookCellStatusBarItem
A contribution to a cell's status bar
NotebookCellStatusBarItemProvider
A provider that can contribute items to the status bar that appears below a cell's editor.
NotebookController
A notebook controller represents an entity that can execute notebook cells. This is often referred to as a kernel.
NotebookData
Raw representation of a notebook.
NotebookDocument
Represents a notebook which itself is a sequence of {@link NotebookCellcode or markup cells}. Notebook documents are
created from {@link NotebookDatanotebook data}.
NotebookDocumentCellChange
Describes a change to a notebook cell.
NotebookDocumentChangeEvent
An event describing a transactional {@link NotebookDocumentnotebook} change.
NotebookDocumentContentChange
Describes a structural change to a notebook document, e.g newly added and removed cells.
NotebookDocumentContentOptions
Notebook content options define what parts of a notebook are persisted. Note
NotebookDocumentShowOptions
Represents options to configure the behavior of showing a {@link NotebookDocumentnotebook document} in an {@link NotebookEditornotebook editor}.
NotebookDocumentWillSaveEvent
An event that is fired when a {@link NotebookDocumentnotebook document} will be saved.
NotebookEdit
A notebook edit represents edits that should be applied to the contents of a notebook.
NotebookEditor
Represents a notebook editor that is attached to a {@link NotebookDocumentnotebook}.
Additional properties of the NotebookEditor are available in the proposed
API, which will be finalized later.
NotebookEditorSelectionChangeEvent
Represents an event describing the change in a {@link NotebookEditor.selectionsnotebook editor's selections}.
NotebookEditorVisibleRangesChangeEvent
Represents an event describing the change in a {@link NotebookEditor.visibleRangesnotebook editor's visibleRanges}.
NotebookRange
A notebook range represents an ordered pair of two cell indices.
It is guaranteed that start is less than or equal to end.
NotebookRendererMessaging
Renderer messaging is used to communicate with a single renderer. It's returned from {@link notebooks.createRendererMessaging}.
NotebookSerializer
The notebook serializer enables the editor to open notebook files.
OnDidChangeCustomDocument
OnEnterRule
Describes a rule to be evaluated when pressing Enter.
OnTypeFormattingEditProvider
The document formatting provider interface defines the contract between extensions and
the formatting-feature.
OpenDialogOptions
Options to configure the behaviour of a file open dialog.
OutputChannel
An output channel is a container for readonly textual information.
ParameterInformation
Represents a parameter of a callable-signature. A parameter can
have a label and a doc-comment.
Position
Represents a line and character position, such as
the position of the cursor.
Process
ProcessExecution
The execution of a task happens as an external process
without shell interaction.
ProcessExecutionOptions
Options for a process execution
Progress <T >
Defines a generalized way of reporting progress updates.
ProgressOptions
Value-object describing where and how progress should show.
Pseudoterminal
Defines the interface of a terminal pty, enabling extensions to control a terminal.
QuickDiffProvider
A quick diff provider provides a {@link Uriuri} to the original state of a
modified resource. The editor will use this information to render ad'hoc diffs
within the text.
QuickInput
A light-weight user input UI that is initially not visible. After
configuring it through its properties the extension can make it
visible by calling {@link QuickInput.show}.
QuickInputButton
Button for an action in a {@link QuickPick} or {@link InputBox}.
QuickInputButtons
Predefined buttons for {@link QuickPick} and {@link InputBox}.
QuickPick <T extends QuickPickItem >
A concrete {@link QuickInput} to let the user pick an item from a
list of items of type T. The items can be filtered through a filter text field and
there is an option {@link QuickPick.canSelectManycanSelectMany} to allow for
selecting multiple items.
QuickPickItem
Represents an item that can be selected from
a list of items.
QuickPickItemButtonEvent <T extends QuickPickItem >
An event signaling when a button in a particular {@link QuickPickItem} was triggered.
This event does not fire for buttons in the title bar.
QuickPickOptions
Options to configure the behavior of the quick pick UI.
Range
A range represents an ordered pair of two positions.
It is guaranteed that {@link Range.startstart}.isBeforeOrEqual({@link Range.endend})
ReferenceContext
Value-object that contains additional information when
requesting references.
ReferenceProvider
The reference provider interface defines the contract between extensions and
the find references -feature.
RelativePattern
A relative pattern is a helper to construct glob patterns that are matched
relatively to a base file path. The base path can either be an absolute file
path as string or uri or a {@link WorkspaceFolderworkspace folder}, which is the
preferred way of creating the relative pattern.
RenameProvider
The rename provider interface defines the contract between extensions and
the rename -feature.
RunOptions
Run options for a task.
SaveDialogOptions
Options to configure the behaviour of a file save dialog.
SecretStorage
Represents a storage utility for secrets, information that is
sensitive.
SecretStorageChangeEvent
The event data that is fired when a secret is added or removed.
SelectedCompletionInfo
Describes the currently selected completion item.
Selection
Represents a text selection in an editor.
SelectionRange
A selection range represents a part of a selection hierarchy. A selection range
may have a parent selection range that contains it.
SelectionRangeProvider
The selection range provider interface defines the contract between extensions and the "Expand and Shrink Selection" feature.
SemanticTokens
Represents semantic tokens, either in a range or in an entire document.
SemanticTokensBuilder
A semantic tokens builder can help with creating a SemanticTokens instance
which contains delta encoded semantic tokens.
SemanticTokensEdit
Represents an edit to semantic tokens.
SemanticTokensEdits
Represents edits to semantic tokens.
SemanticTokensLegend
A semantic tokens legend contains the needed information to decipher
the integer encoded representation of semantic tokens.
ShellExecution
Represents a task execution that happens inside a shell.
ShellExecutionOptions
Options for a shell execution
ShellQuotedString
A string that will be quoted depending on the used shell.
ShellQuotingOptions
The shell quoting options.
SignatureHelp
Signature help represents the signature of something
callable. There can be multiple signatures but only one
active and only one active parameter.
SignatureHelpContext
Additional information about the context in which a
{@linkcode SignatureHelpProvider.provideSignatureHelpSignatureHelpProvider} was triggered.
SignatureHelpProvider
The signature help provider interface defines the contract between extensions and
the parameter hints -feature.
SignatureHelpProviderMetadata
Metadata about a registered {@linkcode SignatureHelpProvider}.
SignatureInformation
Represents the signature of something callable. A signature
can have a label, like a function-name, a doc-comment, and
a set of parameters.
SnippetString
A snippet string is a template which allows to insert text
and to control the editor cursor when insertion happens.
SnippetTextEdit
A snippet edit represents an interactive edit that is performed by
the editor.
SourceBreakpoint
A breakpoint specified by a source location.
SourceControl
An source control is able to provide {@link SourceControlResourceStateresource states}
to the editor and interact with the editor in several source control related ways.
SourceControlInputBox
Represents the input box in the Source Control viewlet.
SourceControlResourceDecorations
The decorations for a {@link SourceControlResourceStatesource control resource state}.
Can be independently specified for light and dark themes.
SourceControlResourceGroup
A source control resource group is a collection of
{@link SourceControlResourceStatesource control resource states}.
SourceControlResourceState
An source control resource state represents the state of an underlying workspace
resource within a certain {@link SourceControlResourceGroupsource control group}.
SourceControlResourceThemableDecorations
The theme-aware decorations for a
{@link SourceControlResourceStatesource control resource state}.
StatusBarItem
A status bar item is a status bar contribution that can
show text and icons and run a command on click.
SymbolInformation
Represents information about programming constructs like variables, classes,
interfaces etc.
Tab
Represents a tab within a {@link TabGroupgroup of tabs}.
Tabs are merely the graphical representation within the editor area.
A backing editor is not a guarantee.
TabChangeEvent
An event describing change to tabs.
TabGroup
Represents a group of tabs. A tab group itself consists of multiple tabs.
TabGroupChangeEvent
An event describing changes to tab groups.
TabGroups
Represents the main editor area which consists of multiple groups which contain tabs.
TabInputCustom
The tab represents a custom editor.
TabInputNotebook
The tab represents a notebook.
TabInputNotebookDiff
The tabs represents two notebooks in a diff configuration.
TabInputTerminal
The tab represents a terminal in the editor area.
TabInputText
The tab represents a single text based resource.
TabInputTextDiff
The tab represents two text based resources
being rendered as a diff.
TabInputWebview
The tab represents a webview.
Task
A task to execute
TaskDefinition
A structure that defines a task kind in the system.
The value must be JSON-stringifyable.
TaskEndEvent
An event signaling the end of an executed task.
TaskExecution
An object representing an executed Task. It can be used
to terminate a task.
TaskFilter
A task filter denotes tasks by their version and types
TaskGroup
A grouping for tasks. The editor by default supports the
'Clean', 'Build', 'RebuildAll' and 'Test' group.
TaskPresentationOptions
Controls how the task is presented in the UI.
TaskProcessEndEvent
An event signaling the end of a process execution
triggered through a task
TaskProcessStartEvent
An event signaling the start of a process execution
triggered through a task
TaskProvider <T extends Task >
A task provider allows to add tasks to the task service.
A task provider is registered via {@link tasks.registerTaskProvider}.
TaskStartEvent
An event signaling the start of a task execution.
TelemetryLogger
A telemetry logger which can be used by extensions to log usage and error telementry.
TelemetryLoggerOptions
Options for creating a {@link TelemetryLogger}
TelemetrySender
The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT
call the methods of their sender directly as the logger provides extra guards and cleaning.
TelemetryTrustedValue <T >
A special value wrapper denoting a value that is safe to not clean.
This is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it.
Terminal
An individual terminal instance within the integrated terminal.
TerminalDimensions
Represents the dimensions of a terminal.
TerminalEditorLocationOptions
Assumes a {@link TerminalLocation} of editor and allows specifying a {@link ViewColumn} and
{@link TerminalEditorLocationOptions.preserveFocuspreserveFocus } property
TerminalExitStatus
Represents how a terminal exited.
TerminalLink
A link on a terminal line.
TerminalLinkContext
Provides information on a line in a terminal in order to provide links for it.
TerminalLinkProvider <T extends TerminalLink >
A provider that enables detection and handling of links within terminals.
TerminalOptions
Value-object describing what options a terminal should use.
TerminalProfile
A terminal profile defines how a terminal will be launched.
TerminalProfileProvider
Provides a terminal profile for the contributed terminal profile when launched via the UI or
command.
TerminalSplitLocationOptions
Uses the parent {@link Terminal}'s location for the terminal
TerminalState
Represents the state of a {@link Terminal}.
TestController
Entry point to discover and execute tests. It contains {@link TestController.items} which
are used to populate the editor UI, and is associated with
{@link TestController.createRunProfilerun profiles} to allow
for tests to be executed.
TestItem
An item shown in the "test explorer" view.
TestItemCollection
Collection of test items, found in {@link TestItem.children} and
{@link TestController.items}.
TestMessage
Message associated with the test state. Can be linked to a specific
source range -- useful for assertion failures, for example.
TestRun
A TestRun represents an in-progress or completed test run and
provides methods to report the state of individual tests in the run.
TestRunProfile
A TestRunProfile describes one way to execute tests in a {@link TestController}.
TestRunRequest
A TestRunRequest is a precursor to a {@link TestRun}, which in turn is
created by passing a request to {@link TestController.createTestRun}. The
TestRunRequest contains information about which tests should be run, which
should not be run, and how they are run (via the {@link TestRunRequest.profileprofile}).
TestTag
Tags can be associated with {@link TestItemTestItems} and
{@link TestRunProfileTestRunProfiles}. A profile with a tag can only
execute tests that include that tag in their {@link TestItem.tags} array.
TextDocument
Represents a text document, such as a source file. Text documents have
{@link TextLinelines} and knowledge about an underlying resource like a file.
TextDocumentChangeEvent
An event describing a transactional {@link TextDocumentdocument} change.
TextDocumentContentChangeEvent
An event describing an individual change in the text of a {@link TextDocumentdocument}.
TextDocumentContentProvider
A text document content provider allows to add readonly documents
to the editor, such as source from a dll or generated html from md.
TextDocumentShowOptions
Represents options to configure the behavior of showing a {@link TextDocumentdocument} in an {@link TextEditoreditor}.
TextDocumentWillSaveEvent
An event that is fired when a {@link TextDocumentdocument} will be saved.
TextEdit
A text edit represents edits that should be applied
to a document.
TextEditor
Represents an editor that is attached to a {@link TextDocumentdocument}.
TextEditorDecorationType
Represents a handle to a set of decorations
sharing the same {@link DecorationRenderOptionsstyling options} in a {@link TextEditortext editor}.
TextEditorEdit
A complex edit that will be applied in one transaction on a TextEditor.
This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.)
they can be applied on a {@link TextDocumentdocument} associated with a {@link TextEditortext editor}.
TextEditorOptions
Represents a {@link TextEditortext editor}'s {@link TextEditor.optionsoptions}.
TextEditorOptionsChangeEvent
Represents an event describing the change in a {@link TextEditor.optionstext editor's options}.
TextEditorSelectionChangeEvent
Represents an event describing the change in a {@link TextEditor.selectionstext editor's selections}.
TextEditorViewColumnChangeEvent
Represents an event describing the change of a {@link TextEditor.viewColumntext editor's view column}.
TextEditorVisibleRangesChangeEvent
Represents an event describing the change in a {@link TextEditor.visibleRangestext editor's visible ranges}.
TextLine
Represents a line of text, such as a line of source code.
ThemableDecorationAttachmentRenderOptions
Represents theme specific rendeirng styles for {@link ThemableDecorationRenderOptions.beforebefore} and
{@link ThemableDecorationRenderOptions.afterafter} the content of text decorations.
ThemableDecorationInstanceRenderOptions
Represents themable render options for decoration instances.
ThemableDecorationRenderOptions
Represents theme specific rendering styles for a {@link TextEditorDecorationTypetext editor decoration}.
ThemeColor
A reference to one of the workbench colors as defined in https://code.visualstudio.com/docs/getstarted/theme-color-reference .
Using a theme color is preferred over a custom color as it gives theme authors and users the possibility to change the color.
ThemeIcon
A reference to a named icon. Currently, {@link ThemeIcon.FileFile}, {@link ThemeIcon.FolderFolder},
and ThemeIcon ids are supported.
Using a theme icon is preferred over a custom icon as it gives product theme authors the possibility to change the icons.
TreeCheckboxChangeEvent <T >
An event describing the change in a tree item's checkbox state.
TreeDataProvider <T >
A data provider that provides tree data
TreeDragAndDropController <T >
Provides support for drag and drop in TreeView.
TreeItem
A tree item is an UI element of the tree. Tree items are created by the {@link TreeDataProviderdata provider}.
TreeItemLabel
Label describing the {@link TreeItemTree item}
TreeView <T >
Represents a Tree view
TreeViewExpansionEvent <T >
The event that is fired when an element in the {@link TreeView} is expanded or collapsed
TreeViewOptions <T >
Options for creating a {@link TreeView}
TreeViewSelectionChangeEvent <T >
The event that is fired when there is a change in {@link TreeView.selectiontree view's selection}
TreeViewVisibilityChangeEvent
The event that is fired when there is a change in {@link TreeView.visibletree view's visibility}
TypeDefinitionProvider
The type definition provider defines the contract between extensions and
the go to type definition feature.
TypeHierarchyItem
Represents an item of a type hierarchy, like a class or an interface.
TypeHierarchyProvider
The type hierarchy provider interface describes the contract between extensions
and the type hierarchy feature.
Uri
A universal resource identifier representing either a file on disk
or another resource, like untitled resources.
UriHandler
A uri handler is responsible for handling system-wide {@link Uriuris}.
ViewBadge
A badge presenting a value for a view
WebSocket
Webview
Displays html content, similarly to an iframe.
WebviewOptions
Content settings for a webview.
WebviewPanel
A panel that contains a webview.
WebviewPanelOnDidChangeViewStateEvent
Event fired when a webview panel's view state changes.
WebviewPanelOptions
Content settings for a webview panel.
WebviewPanelSerializer <T >
Restore webview panels that have been persisted when vscode shuts down.
WebviewPortMapping
Defines a port mapping used for localhost inside the webview.
WebviewView
A webview based view.
WebviewViewProvider
Provider for creating WebviewView elements.
WebviewViewResolveContext <T >
Additional information the webview view being resolved.
WindowState
Represents the state of a window.
WorkspaceConfiguration
Represents the configuration. It is a merged view of
WorkspaceEdit
A workspace edit is a collection of textual and files changes for
multiple resources and documents.
WorkspaceEditEntryMetadata
Additional data for entries of a workspace edit. Supports to label entries and marks entries
as needing confirmation by the user. The editor groups edits with equal labels into tree nodes,
for instance all edits labelled with "Changes in Strings" would be a tree node.
WorkspaceEditMetadata
Additional data about a workspace edit.
WorkspaceFolder
A workspace folder is one of potentially many roots opened by the editor. All workspace folders
are equal which means there is no notion of an active or primary workspace folder.
WorkspaceFolderPickOptions
Options to configure the behaviour of the {@link WorkspaceFolderworkspace folder} pick UI.
WorkspaceFoldersChangeEvent
An event describing a change to the set of {@link workspace.workspaceFoldersworkspace folders}.
WorkspaceSymbolProvider <T extends SymbolInformation >
The workspace symbol provider interface defines the contract between extensions and
the symbol search -feature.
