VS Code API is a set of JavaScript APIs that you can invoke in your Visual Studio Code extension. This page lists all VS Code APIs available to extension authors.
API namespaces and classesThis listing is compiled from the vscode.d.ts file from the VS Code repository.
authentication EventsonDidChangeSessions: Event<AuthenticationSessionsChangeEvent>
FunctionsgetAccounts(providerId: string): Thenable<readonly AuthenticationSessionAccountInformation[]>
getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & {createIfNone: true | AuthenticationGetSessionPresentationOptions}): Thenable<AuthenticationSession>
getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & {forceNewSession: true | AuthenticationGetSessionPresentationOptions}): Thenable<AuthenticationSession>
getSession(providerId: string, scopes: readonly string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>
registerAuthenticationProvider(id: string, label: string, provider: AuthenticationProvider, options?: AuthenticationProviderOptions): Disposable
chat FunctionscreateChatParticipant(id: string, handler: ChatRequestHandler): ChatParticipant
commands FunctionsexecuteCommand<T>(command: string, ...rest: any[]): Thenable<T>
Parameter Description command: string ...rest: any[] Returns Description Thenable<T>getCommands(filterInternal?: boolean): Thenable<string[]>
Parameter Description filterInternal?: boolean Returns Description Thenable<string[]>registerCommand(command: string, callback: (args: any[]) => any, thisArg?: any): Disposable
Parameter Description command: string callback: (args: any[]) => any thisArg?: any Returns Description DisposableregisterTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, args: any[]) => void, thisArg?: any): Disposable
FunctionscreateCommentController(id: string, label: string): CommentController
debug VariablesactiveDebugConsole: DebugConsole
activeDebugSession: DebugSession | undefined
activeStackItem: DebugThread | DebugStackFrame | undefined
breakpoints: readonly Breakpoint[]
EventsonDidChangeActiveDebugSession: Event<DebugSession | undefined>
onDidChangeActiveStackItem: Event<DebugThread | DebugStackFrame | undefined>
onDidChangeBreakpoints: Event<BreakpointsChangeEvent>
onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>
onDidStartDebugSession: Event<DebugSession>
onDidTerminateDebugSession: Event<DebugSession>
FunctionsaddBreakpoints(breakpoints: readonly Breakpoint[]): void
Parameter Description breakpoints: readonly Breakpoint[] Returns Description voidasDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri
registerDebugAdapterDescriptorFactory(debugType: string, factory: DebugAdapterDescriptorFactory): Disposable
registerDebugAdapterTrackerFactory(debugType: string, factory: DebugAdapterTrackerFactory): Disposable
registerDebugConfigurationProvider(debugType: string, provider: DebugConfigurationProvider, triggerKind?: DebugConfigurationProviderTriggerKind): Disposable
removeBreakpoints(breakpoints: readonly Breakpoint[]): void
Parameter Description breakpoints: readonly Breakpoint[] Returns Description voidstartDebugging(folder: WorkspaceFolder, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions): Thenable<boolean>
stopDebugging(session?: DebugSession): Thenable<void>
Parameter Description session?: DebugSession Returns Description Thenable<void> env Variablesclipboard: Clipboard
logLevel: LogLevel
remoteName: string | undefined
uiKind: UIKind
EventsonDidChangeLogLevel: Event<LogLevel>
onDidChangeShell: Event<string>
onDidChangeTelemetryEnabled: Event<boolean>
FunctionsasExternalUri(target: Uri): Thenable<Uri>
Parameter Description target: Uri Returns Description Thenable<Uri>createTelemetryLogger(sender: TelemetrySender, options?: TelemetryLoggerOptions): TelemetryLogger
openExternal(target: Uri): Thenable<boolean>
Parameter Description target: Uri Returns Description Thenable<boolean> extensions Variablesall: readonly Extension<any>[]
EventsonDidChange: Event<void>
FunctionsgetExtension<T>(extensionId: string): Extension<T> | undefined
Parameter Description extensionId: string Returns Description Extension<T> | undefined l10n Variablesuri: Uri | undefined
Functionst(message: string, ...args: Array<string | number | boolean>): string
Parameter Description message: string ...args: Array<string | number | boolean> Returns Description stringt(message: string, args: Record<string, any>): string
Parameter Description message: string args: Record<string, any> Returns Description stringt(options: {args: Array<string | number | boolean> | Record<string, any>, comment: string | string[], message: string}): string
Parameter Description options: {args: Array<string | number | boolean> | Record<string, any>, comment: string | string[], message: string} Returns Description string languages EventsonDidChangeDiagnostics: Event<DiagnosticChangeEvent>
FunctionscreateDiagnosticCollection(name?: string): DiagnosticCollection
createLanguageStatusItem(id: string, selector: DocumentSelector): LanguageStatusItem
getDiagnostics(resource: Uri): Diagnostic[]
Parameter Description resource: Uri Returns Description Diagnostic[]getDiagnostics(): Array<[Uri, Diagnostic[]]>
Parameter Description Returns Description Array<[Uri, Diagnostic[]]>getLanguages(): Thenable<string[]>
Parameter Description Returns Description Thenable<string[]>match(selector: DocumentSelector, document: TextDocument): number
registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable
registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider<CodeAction>, metadata?: CodeActionProviderMetadata): Disposable
registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider<CodeLens>): Disposable
registerColorProvider(selector: DocumentSelector, provider: DocumentColorProvider): Disposable
registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider<CompletionItem>, ...triggerCharacters: string[]): Disposable
registerDeclarationProvider(selector: DocumentSelector, provider: DeclarationProvider): Disposable
registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable
registerDocumentDropEditProvider(selector: DocumentSelector, provider: DocumentDropEditProvider<DocumentDropEdit>, metadata?: DocumentDropEditProviderMetadata): Disposable
registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable
registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable
registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider<DocumentLink>): Disposable
registerDocumentPasteEditProvider(selector: DocumentSelector, provider: DocumentPasteEditProvider<DocumentPasteEdit>, metadata: DocumentPasteProviderMetadata): Disposable
registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable
registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable
registerDocumentSemanticTokensProvider(selector: DocumentSelector, provider: DocumentSemanticTokensProvider, legend: SemanticTokensLegend): Disposable
registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider, metaData?: DocumentSymbolProviderMetadata): Disposable
registerEvaluatableExpressionProvider(selector: DocumentSelector, provider: EvaluatableExpressionProvider): Disposable
registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable
registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable
registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable
registerInlayHintsProvider(selector: DocumentSelector, provider: InlayHintsProvider<InlayHint>): Disposable
registerInlineCompletionItemProvider(selector: DocumentSelector, provider: InlineCompletionItemProvider): Disposable
registerInlineValuesProvider(selector: DocumentSelector, provider: InlineValuesProvider): Disposable
registerLinkedEditingRangeProvider(selector: DocumentSelector, provider: LinkedEditingRangeProvider): Disposable
registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable
registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable
registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable
registerSelectionRangeProvider(selector: DocumentSelector, provider: SelectionRangeProvider): Disposable
registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable
registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, metadata: SignatureHelpProviderMetadata): Disposable
registerTypeDefinitionProvider(selector: DocumentSelector, provider: TypeDefinitionProvider): Disposable
registerTypeHierarchyProvider(selector: DocumentSelector, provider: TypeHierarchyProvider): Disposable
registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider<SymbolInformation>): Disposable
setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable
setTextDocumentLanguage(document: TextDocument, languageId: string): Thenable<TextDocument>
lm Variablestools: readonly LanguageModelToolInformation[]
EventsonDidChangeChatModels: Event<void>
FunctionsinvokeTool(name: string, options: LanguageModelToolInvocationOptions<object>, token?: CancellationToken): Thenable<LanguageModelToolResult>
registerMcpServerDefinitionProvider(id: string, provider: McpServerDefinitionProvider<McpServerDefinition>): Disposable
registerTool<T>(name: string, tool: LanguageModelTool<T>): Disposable
selectChatModels(selector?: LanguageModelChatSelector): Thenable<LanguageModelChat[]>
notebooks FunctionscreateNotebookController(id: string, notebookType: string, label: string, handler?: (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController) => void | Thenable<void>): NotebookController
createRendererMessaging(rendererId: string): NotebookRendererMessaging
registerNotebookCellStatusBarItemProvider(notebookType: string, provider: NotebookCellStatusBarItemProvider): Disposable
scm VariablesinputBox: SourceControlInputBox
FunctionscreateSourceControl(id: string, label: string, rootUri?: Uri): SourceControl
Parameter Description id: string label: string rootUri?: Uri Returns Description SourceControl tasks VariablestaskExecutions: readonly TaskExecution[]
EventsonDidEndTask: Event<TaskEndEvent>
onDidEndTaskProcess: Event<TaskProcessEndEvent>
onDidStartTask: Event<TaskStartEvent>
onDidStartTaskProcess: Event<TaskProcessStartEvent>
FunctionsexecuteTask(task: Task): Thenable<TaskExecution>
fetchTasks(filter?: TaskFilter): Thenable<Task[]>
Parameter Description filter?: TaskFilter Returns Description Thenable<Task[]>registerTaskProvider(type: string, provider: TaskProvider<Task>): Disposable
tests FunctionscreateTestController(id: string, label: string): TestController
Parameter Description id: string label: string Returns Description TestController window VariablesactiveColorTheme: ColorTheme
activeNotebookEditor: NotebookEditor | undefined
activeTerminal: Terminal | undefined
activeTextEditor: TextEditor | undefined
state: WindowState
tabGroups: TabGroups
terminals: readonly Terminal[]
visibleNotebookEditors: readonly NotebookEditor[]
visibleTextEditors: readonly TextEditor[]
EventsonDidChangeActiveColorTheme: Event<ColorTheme>
onDidChangeActiveNotebookEditor: Event<NotebookEditor | undefined>
onDidChangeActiveTerminal: Event<Terminal | undefined>
onDidChangeActiveTextEditor: Event<TextEditor | undefined>
onDidChangeNotebookEditorSelection: Event<NotebookEditorSelectionChangeEvent>
onDidChangeNotebookEditorVisibleRanges: Event<NotebookEditorVisibleRangesChangeEvent>
onDidChangeTerminalShellIntegration: Event<TerminalShellIntegrationChangeEvent>
onDidChangeTerminalState: Event<Terminal>
onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>
onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>
onDidChangeTextEditorViewColumn: Event<TextEditorViewColumnChangeEvent>
onDidChangeTextEditorVisibleRanges: Event<TextEditorVisibleRangesChangeEvent>
onDidChangeVisibleNotebookEditors: Event<readonly NotebookEditor[]>
onDidChangeVisibleTextEditors: Event<readonly TextEditor[]>
onDidChangeWindowState: Event<WindowState>
onDidCloseTerminal: Event<Terminal>
onDidEndTerminalShellExecution: Event<TerminalShellExecutionEndEvent>
onDidOpenTerminal: Event<Terminal>
onDidStartTerminalShellExecution: Event<TerminalShellExecutionStartEvent>
FunctionscreateInputBox(): InputBox
Parameter Description Returns Description InputBoxcreateOutputChannel(name: string, languageId?: string): OutputChannel
Parameter Description name: string languageId?: string Returns Description OutputChannelcreateOutputChannel(name: string, options: {log: true}): LogOutputChannel
Parameter Description name: string options: {log: true} Returns Description LogOutputChannelcreateQuickPick<T extends QuickPickItem>(): QuickPick<T>
Parameter Description Returns Description QuickPick<T>createStatusBarItem(id: string, alignment?: StatusBarAlignment, priority?: number): StatusBarItem
createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem
createTerminal(name?: string, shellPath?: string, shellArgs?: string | readonly string[]): Terminal
Parameter Description name?: string shellPath?: string shellArgs?: string | readonly string[] Returns Description TerminalcreateTerminal(options: TerminalOptions): Terminal
createTerminal(options: ExtensionTerminalOptions): Terminal
createTextEditorDecorationType(options: DecorationRenderOptions): TextEditorDecorationType
createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T>
createWebviewPanel(viewType: string, title: string, showOptions: ViewColumn | {preserveFocus: boolean, viewColumn: ViewColumn}, options?: WebviewPanelOptions & WebviewOptions): WebviewPanel
registerCustomEditorProvider(viewType: string, provider: CustomTextEditorProvider | CustomReadonlyEditorProvider<CustomDocument> | CustomEditorProvider<CustomDocument>, options?: {supportsMultipleEditorsPerDocument: boolean, webviewOptions: WebviewPanelOptions}): Disposable
registerFileDecorationProvider(provider: FileDecorationProvider): Disposable
registerTerminalLinkProvider(provider: TerminalLinkProvider<TerminalLink>): Disposable
registerTerminalProfileProvider(id: string, provider: TerminalProfileProvider): Disposable
registerTreeDataProvider<T>(viewId: string, treeDataProvider: TreeDataProvider<T>): Disposable
registerUriHandler(handler: UriHandler): Disposable
registerWebviewPanelSerializer(viewType: string, serializer: WebviewPanelSerializer<unknown>): Disposable
registerWebviewViewProvider(viewId: string, provider: WebviewViewProvider, options?: {webviewOptions: {retainContextWhenHidden: boolean}}): Disposable
Parameter Description viewId: string provider: WebviewViewProvider options?: {webviewOptions: {retainContextWhenHidden: boolean}} Returns Description DisposablesetStatusBarMessage(text: string, hideAfterTimeout: number): Disposable
Parameter Description text: string hideAfterTimeout: number Returns Description DisposablesetStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable
Parameter Description text: string hideWhenDone: Thenable<any> Returns Description DisposablesetStatusBarMessage(text: string): Disposable
Parameter Description text: string Returns Description DisposableshowErrorMessage<T extends string>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showErrorMessage<T extends string>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showInformationMessage<T extends string>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showInformationMessage<T extends string>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>
showNotebookDocument(document: NotebookDocument, options?: NotebookDocumentShowOptions): Thenable<NotebookEditor>
showOpenDialog(options?: OpenDialogOptions): Thenable<Uri[] | undefined>
showQuickPick(items: readonly string[] | Thenable<readonly string[]>, options: QuickPickOptions & {canPickMany: true}, token?: CancellationToken): Thenable<string[] | undefined>
Parameter Description items: readonly string[] | Thenable<readonly string[]> options: QuickPickOptions & {canPickMany: true} token?: CancellationToken Returns Description Thenable<string[] | undefined>showQuickPick(items: readonly string[] | Thenable<readonly string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>
Parameter Description items: readonly string[] | Thenable<readonly string[]> options?: QuickPickOptions token?: CancellationToken Returns Description Thenable<string | undefined>showQuickPick<T extends QuickPickItem>(items: readonly T[] | Thenable<readonly T[]>, options: QuickPickOptions & {canPickMany: true}, token?: CancellationToken): Thenable<T[] | undefined>
Parameter Description items: readonly T[] | Thenable<readonly T[]> options: QuickPickOptions & {canPickMany: true} token?: CancellationToken Returns Description Thenable<T[] | undefined>showQuickPick<T extends QuickPickItem>(items: readonly T[] | Thenable<readonly T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>
showSaveDialog(options?: SaveDialogOptions): Thenable<Uri | undefined>
showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>
showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>
showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>
showWarningMessage<T extends string>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showWarningMessage<T extends string>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string ...items: T[] Returns Description Thenable<T | undefined>showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>
Parameter Description message: string options: MessageOptions ...items: T[] Returns Description Thenable<T | undefined>showWorkspaceFolderPick(options?: WorkspaceFolderPickOptions): Thenable<WorkspaceFolder | undefined>
withProgress<R>(options: ProgressOptions, task: (progress: Progress<{increment: number, message: string}>, token: CancellationToken) => Thenable<R>): Thenable<R>
withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>
Parameter Description task: (progress: Progress<number>) => Thenable<R> Returns Description Thenable<R> workspace Variablesfs: FileSystem
notebookDocuments: readonly NotebookDocument[]
textDocuments: readonly TextDocument[]
workspaceFile: Uri | undefined
workspaceFolders: readonly WorkspaceFolder[] | undefined
EventsonDidChangeConfiguration: Event<ConfigurationChangeEvent>
onDidChangeNotebookDocument: Event<NotebookDocumentChangeEvent>
onDidChangeTextDocument: Event<TextDocumentChangeEvent>
onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent>
onDidCloseNotebookDocument: Event<NotebookDocument>
onDidCloseTextDocument: Event<TextDocument>
onDidCreateFiles: Event<FileCreateEvent>
onDidDeleteFiles: Event<FileDeleteEvent>
onDidGrantWorkspaceTrust: Event<void>
onDidOpenNotebookDocument: Event<NotebookDocument>
onDidOpenTextDocument: Event<TextDocument>
onDidRenameFiles: Event<FileRenameEvent>
onDidSaveNotebookDocument: Event<NotebookDocument>
onDidSaveTextDocument: Event<TextDocument>
onWillCreateFiles: Event<FileWillCreateEvent>
onWillDeleteFiles: Event<FileWillDeleteEvent>
onWillRenameFiles: Event<FileWillRenameEvent>
onWillSaveNotebookDocument: Event<NotebookDocumentWillSaveEvent>
onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>
FunctionsapplyEdit(edit: WorkspaceEdit, metadata?: WorkspaceEditMetadata): Thenable<boolean>
asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string
Parameter Description pathOrUri: string | Uri includeWorkspaceFolder?: boolean Returns Description stringcreateFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher
Parameter Description globPattern: GlobPattern ignoreCreateEvents?: boolean ignoreChangeEvents?: boolean ignoreDeleteEvents?: boolean Returns Description FileSystemWatcherdecode(content: Uint8Array): Thenable<string>
Parameter Description content: Uint8Array Returns Description Thenable<string>decode(content: Uint8Array, options: {encoding: string}): Thenable<string>
Parameter Description content: Uint8Array options: {encoding: string} Returns Description Thenable<string>decode(content: Uint8Array, options: {uri: Uri}): Thenable<string>
Parameter Description content: Uint8Array options: {uri: Uri} Returns Description Thenable<string>encode(content: string): Thenable<Uint8Array>
Parameter Description content: string Returns Description Thenable<Uint8Array>encode(content: string, options: {encoding: string}): Thenable<Uint8Array>
Parameter Description content: string options: {encoding: string} Returns Description Thenable<Uint8Array>encode(content: string, options: {uri: Uri}): Thenable<Uint8Array>
Parameter Description content: string options: {uri: Uri} Returns Description Thenable<Uint8Array>findFiles(include: GlobPattern, exclude?: GlobPattern, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>
getConfiguration(section?: string, scope?: ConfigurationScope): WorkspaceConfiguration
getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined
openNotebookDocument(uri: Uri): Thenable<NotebookDocument>
openNotebookDocument(notebookType: string, content?: NotebookData): Thenable<NotebookDocument>
openTextDocument(uri: Uri, options?: {encoding: string}): Thenable<TextDocument>
Parameter Description uri: Uri options?: {encoding: string} Returns Description Thenable<TextDocument>openTextDocument(path: string, options?: {encoding: string}): Thenable<TextDocument>
Parameter Description path: string options?: {encoding: string} Returns Description Thenable<TextDocument>openTextDocument(options?: {content: string, encoding: string, language: string}): Thenable<TextDocument>
Parameter Description options?: {content: string, encoding: string, language: string} Returns Description Thenable<TextDocument>registerFileSystemProvider(scheme: string, provider: FileSystemProvider, options?: {isCaseSensitive: boolean, isReadonly: boolean | MarkdownString}): Disposable
registerNotebookSerializer(notebookType: string, serializer: NotebookSerializer, options?: NotebookDocumentContentOptions): Disposable
registerTaskProvider(type: string, provider: TaskProvider<Task>): Disposable
registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable
save(uri: Uri): Thenable<Uri | undefined>
Parameter Description uri: Uri Returns Description Thenable<Uri | undefined>saveAll(includeUntitled?: boolean): Thenable<boolean>
Parameter Description includeUntitled?: boolean Returns Description Thenable<boolean>saveAs(uri: Uri): Thenable<Uri | undefined>
Parameter Description uri: Uri Returns Description Thenable<Uri | undefined>updateWorkspaceFolders(start: number, deleteCount: number, ...workspaceFoldersToAdd: Array<{name: string, uri: Uri}>): boolean
Parameter Description start: number deleteCount: number ...workspaceFoldersToAdd: Array<{name: string, uri: Uri}> Returns Description boolean AccessibilityInformation Properties AuthenticationForceNewSessionOptionsAuthenticationForceNewSessionOptions: AuthenticationGetSessionPresentationOptions
AuthenticationGetSessionOptions Propertiesaccount?: AuthenticationSessionAccountInformation
clearSessionPreference?: boolean
createIfNone?: boolean | AuthenticationGetSessionPresentationOptions
forceNewSession?: boolean | AuthenticationGetSessionPresentationOptions
AuthenticationGetSessionPresentationOptions Properties AuthenticationProvider EventsonDidChangeSessions: Event<AuthenticationProviderAuthenticationSessionsChangeEvent>
MethodscreateSession(scopes: readonly string[], options: AuthenticationProviderSessionOptions): Thenable<AuthenticationSession>
getSessions(scopes: readonly string[], options: AuthenticationProviderSessionOptions): Thenable<AuthenticationSession[]>
removeSession(sessionId: string): Thenable<void>
Parameter Description sessionId: string Returns Description Thenable<void> AuthenticationProviderAuthenticationSessionsChangeEvent Propertiesadded: readonly AuthenticationSession[]
changed: readonly AuthenticationSession[]
removed: readonly AuthenticationSession[]
AuthenticationProviderInformation Properties AuthenticationProviderOptions PropertiessupportsMultipleAccounts?: boolean
AuthenticationProviderSessionOptions Propertiesaccount?: AuthenticationSessionAccountInformation
AuthenticationSession Propertiesaccount: AuthenticationSessionAccountInformation
AuthenticationSessionAccountInformation Properties AuthenticationSessionsChangeEvent Propertiesprovider: AuthenticationProviderInformation
AutoClosingPair PropertiesnotIn?: SyntaxTokenType[]
BranchCoverage Constructorsnew BranchCoverage(executed: number | boolean, location?: Range | Position, label?: string): BranchCoverage
Properties Breakpoint Constructorsnew Breakpoint(enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string): Breakpoint
Parameter Description enabled?: boolean condition?: string hitCondition?: string logMessage?: string Returns Description Breakpoint Properties BreakpointsChangeEvent Propertiesadded: readonly Breakpoint[]
changed: readonly Breakpoint[]
removed: readonly Breakpoint[]
CallHierarchyIncomingCall Constructorsnew CallHierarchyIncomingCall(item: CallHierarchyItem, fromRanges: Range[]): CallHierarchyIncomingCall
Propertiesfrom: CallHierarchyItem
fromRanges: Range[]
CallHierarchyItem Constructorsnew CallHierarchyItem(kind: SymbolKind, name: string, detail: string, uri: Uri, range: Range, selectionRange: Range): CallHierarchyItem
Propertieskind: SymbolKind
range: Range
selectionRange: Range
tags?: readonly SymbolTag[]
uri: Uri
CallHierarchyOutgoingCall Constructorsnew CallHierarchyOutgoingCall(item: CallHierarchyItem, fromRanges: Range[]): CallHierarchyOutgoingCall
PropertiesfromRanges: Range[]
CallHierarchyProvider MethodsprepareCallHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CallHierarchyItem | CallHierarchyItem[]>
provideCallHierarchyIncomingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyIncomingCall[]>
provideCallHierarchyOutgoingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyOutgoingCall[]>
CancellationError Constructorsnew CancellationError(): CancellationError
CancellationToken PropertiesisCancellationRequested: boolean
onCancellationRequested: Event<any>
CancellationTokenSource Constructorsnew CancellationTokenSource(): CancellationTokenSource
Propertiestoken: CancellationToken
Methods Parameter Description Returns Description void Parameter Description Returns Description void CharacterPairCharacterPair: [string, string]
ChatContext Propertieshistory: ReadonlyArray<ChatRequestTurn | ChatResponseTurn>
ChatErrorDetails Properties ChatFollowup Properties ChatFollowupProvider MethodsprovideFollowups(result: ChatResult, context: ChatContext, token: CancellationToken): ProviderResult<ChatFollowup[]>
ChatLanguageModelToolReference Propertiesrange?: [start: number, end: number]
ChatParticipant EventsonDidReceiveFeedback: Event<ChatResultFeedback>
PropertiesfollowupProvider?: ChatFollowupProvider
iconPath?: IconPath
requestHandler: ChatRequestHandler
Methods Parameter Description Returns Description void ChatParticipantToolTokenChatParticipantToolToken: never
ChatPromptReference Propertiesrange?: [start: number, end: number]
ChatRequest Propertiesmodel: LanguageModelChat
references: readonly ChatPromptReference[]
toolReferences: readonly ChatLanguageModelToolReference[]
ChatRequestHandlerChatRequestHandler: (request: ChatRequest, context: ChatContext, response: ChatResponseStream, token: CancellationToken) => ProviderResult<ChatResult | void>
ChatRequestTurn Propertiesreferences: ChatPromptReference[]
toolReferences: readonly ChatLanguageModelToolReference[]
ChatResponseAnchorPart Constructorsnew ChatResponseAnchorPart(value: Uri | Location, title?: string): ChatResponseAnchorPart
Properties ChatResponseCommandButtonPart Constructorsnew ChatResponseCommandButtonPart(value: Command): ChatResponseCommandButtonPart
Propertiesvalue: Command
ChatResponseFileTree Propertieschildren?: ChatResponseFileTree[]
ChatResponseFileTreePart Constructorsnew ChatResponseFileTreePart(value: ChatResponseFileTree[], baseUri: Uri): ChatResponseFileTreePart
PropertiesbaseUri: Uri
value: ChatResponseFileTree[]
ChatResponseMarkdownPart Constructorsnew ChatResponseMarkdownPart(value: string | MarkdownString): ChatResponseMarkdownPart
Propertiesvalue: MarkdownString
ChatResponsePartChatResponsePart: ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseProgressPart | ChatResponseReferencePart | ChatResponseCommandButtonPart
ChatResponseProgressPart Constructorsnew ChatResponseProgressPart(value: string): ChatResponseProgressPart
Properties ChatResponseReferencePart Constructorsnew ChatResponseReferencePart(value: Uri | Location, iconPath?: IconPath): ChatResponseReferencePart
PropertiesiconPath?: IconPath
ChatResponseStream Methodsanchor(value: Uri | Location, title?: string): void
Parameter Description value: Uri | Location title?: string Returns Description voidbutton(command: Command): void
Parameter Description command: Command Returns Description voidfiletree(value: ChatResponseFileTree[], baseUri: Uri): void
markdown(value: string | MarkdownString): void
Parameter Description value: string | MarkdownString Returns Description void Parameter Description value: string Returns Description voidpush(part: ChatResponsePart): void
reference(value: Uri | Location, iconPath?: IconPath): void
ChatResponseTurn Propertiesresponse: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart>
result: ChatResult
ChatResult PropertieserrorDetails?: ChatErrorDetails
ChatResultFeedback Propertieskind: ChatResultFeedbackKind
result: ChatResult
ChatResultFeedbackKind Enumeration Members Clipboard Methods Parameter Description Returns Description Thenable<string>writeText(value: string): Thenable<void>
Parameter Description value: string Returns Description Thenable<void> CodeAction Constructorsnew CodeAction(title: string, kind?: CodeActionKind): CodeAction
Propertiescommand?: Command
diagnostics?: Diagnostic[]
Parameter Description reason: stringedit?: WorkspaceEdit
kind?: CodeActionKind
CodeActionContext Propertiesdiagnostics: readonly Diagnostic[]
only: CodeActionKind
triggerKind: CodeActionTriggerKind
CodeActionKind StaticEmpty: CodeActionKind
Notebook: CodeActionKind
QuickFix: CodeActionKind
Refactor: CodeActionKind
RefactorExtract: CodeActionKind
RefactorInline: CodeActionKind
RefactorMove: CodeActionKind
RefactorRewrite: CodeActionKind
Source: CodeActionKind
SourceFixAll: CodeActionKind
SourceOrganizeImports: CodeActionKind
Constructorsnew CodeActionKind(value: string): CodeActionKind
Parameter Description value: string Returns Description CodeActionKind Properties Methodsappend(parts: string): CodeActionKind
Parameter Description parts: string Returns Description CodeActionKindcontains(other: CodeActionKind): boolean
Parameter Description other: CodeActionKind Returns Description booleanintersects(other: CodeActionKind): boolean
Parameter Description other: CodeActionKind Returns Description boolean CodeActionProvider<T> MethodsprovideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken): ProviderResult<Array<Command | T>>
resolveCodeAction(codeAction: T, token: CancellationToken): ProviderResult<T>
CodeActionProviderMetadata Propertiesdocumentation?: ReadonlyArray<{command: Command, kind: CodeActionKind}>
providedCodeActionKinds?: readonly CodeActionKind[]
CodeActionTriggerKind Enumeration Members CodeLens Constructorsnew CodeLens(range: Range, command?: Command): CodeLens
Propertiescommand?: Command
range: Range
CodeLensProvider<T> EventsonDidChangeCodeLenses?: Event<void>
MethodsprovideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<T[]>
resolveCodeLens(codeLens: T, token: CancellationToken): ProviderResult<T>
Color Constructorsnew Color(red: number, green: number, blue: number, alpha: number): Color
Parameter Description red: number green: number blue: number alpha: number Returns Description Color Properties ColorInformation Constructorsnew ColorInformation(range: Range, color: Color): ColorInformation
Propertiescolor: Color
range: Range
ColorPresentation Constructorsnew ColorPresentation(label: string): ColorPresentation
PropertiesadditionalTextEdits?: TextEdit[]
textEdit?: TextEdit
ColorTheme Propertieskind: ColorThemeKind
ColorThemeKind Enumeration Members Command Properties Propertiesauthor: CommentAuthorInformation
body: string | MarkdownString
mode: CommentMode
reactions?: CommentReaction[]
PropertiesiconPath?: Uri
PropertiescommentingRangeProvider?: CommentingRangeProvider
options?: CommentOptions
reactionHandler?: (comment: Comment, reaction: CommentReaction) => Thenable<void>
MethodscreateCommentThread(uri: Uri, range: Range, comments: readonly Comment[]): CommentThread
Parameter Description Returns Description void MethodsprovideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[] | CommentingRanges>
Propertiesranges?: Range[]
Enumeration Members Properties PropertiesiconPath: string | Uri
Propertiesthread: CommentThread
PropertiesblockComment?: CharacterPair
PropertiescanReply: boolean | CommentAuthorInformation
collapsibleState: CommentThreadCollapsibleState
comments: readonly Comment[]
range: Range
state?: CommentThreadState
uri: Uri
Methods Parameter Description Returns Description void Enumeration Members Enumeration Members CompletionContext PropertiestriggerKind: CompletionTriggerKind
CompletionItem Constructorsnew CompletionItem(label: string | CompletionItemLabel, kind?: CompletionItemKind): CompletionItem
PropertiesadditionalTextEdits?: TextEdit[]
command?: Command
documentation?: string | MarkdownString
insertText?: string | SnippetString
kind?: CompletionItemKind
label: string | CompletionItemLabel
range?: Range | {inserting: Range, replacing: Range}
tags?: readonly CompletionItemTag[]
textEdit?: TextEdit
CompletionItemKind Enumeration Members CompletionItemLabel Properties CompletionItemProvider<T> MethodsprovideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionList<T> | T[]>
resolveCompletionItem(item: T, token: CancellationToken): ProviderResult<T>
CompletionItemTag Enumeration Members CompletionList<T> Constructorsnew CompletionList<T extends CompletionItem>(items?: T[], isIncomplete?: boolean): CompletionList<T>
Parameter Description items?: T[] isIncomplete?: boolean Returns Description CompletionList<T> Properties CompletionTriggerKind Enumeration MembersTriggerForIncompleteCompletions: 2
ConfigurationChangeEvent MethodsaffectsConfiguration(section: string, scope?: ConfigurationScope): boolean
Parameter Description section: string scope?: ConfigurationScope Returns Description boolean ConfigurationScopeConfigurationScope: Uri | TextDocument | WorkspaceFolder | {languageId: string, uri: Uri}
ConfigurationTarget Enumeration Members CustomDocument Propertiesuri: Uri
Methods Parameter Description Returns Description void CustomDocumentBackup Properties Methods Parameter Description Returns Description void CustomDocumentBackupContext Propertiesdestination: Uri
CustomDocumentContentChangeEvent<T> Properties CustomDocumentEditEvent<T> Properties Methods Parameter Description Returns Description void | Thenable<void> Parameter Description Returns Description void | Thenable<void> CustomDocumentOpenContext PropertiesuntitledDocumentData: Uint8Array
CustomEditorProvider<T> EventsonDidChangeCustomDocument: Event<CustomDocumentEditEvent<T>> | Event<CustomDocumentContentChangeEvent<T>>
MethodsbackupCustomDocument(document: T, context: CustomDocumentBackupContext, cancellation: CancellationToken): Thenable<CustomDocumentBackup>
openCustomDocument(uri: Uri, openContext: CustomDocumentOpenContext, token: CancellationToken): T | Thenable<T>
resolveCustomEditor(document: T, webviewPanel: WebviewPanel, token: CancellationToken): void | Thenable<void>
revertCustomDocument(document: T, cancellation: CancellationToken): Thenable<void>
Parameter Description document: T cancellation: CancellationToken Returns Description Thenable<void>saveCustomDocument(document: T, cancellation: CancellationToken): Thenable<void>
Parameter Description document: T cancellation: CancellationToken Returns Description Thenable<void>saveCustomDocumentAs(document: T, destination: Uri, cancellation: CancellationToken): Thenable<void>
Parameter Description document: T destination: Uri cancellation: CancellationToken Returns Description Thenable<void> CustomExecution Constructorsnew CustomExecution(callback: (resolvedDefinition: TaskDefinition) => Thenable<Pseudoterminal>): CustomExecution
CustomReadonlyEditorProvider<T> MethodsopenCustomDocument(uri: Uri, openContext: CustomDocumentOpenContext, token: CancellationToken): T | Thenable<T>
resolveCustomEditor(document: T, webviewPanel: WebviewPanel, token: CancellationToken): void | Thenable<void>
CustomTextEditorProvider MethodsresolveCustomTextEditor(document: TextDocument, webviewPanel: WebviewPanel, token: CancellationToken): void | Thenable<void>
DataTransfer Constructorsnew DataTransfer(): DataTransfer
Methods[iterator](): IterableIterator<[mimeType: string, item: DataTransferItem]>
Parameter Description Returns Description IterableIterator<[mimeType: string, item: DataTransferItem]>forEach(callbackfn: (item: DataTransferItem, mimeType: string, dataTransfer: DataTransfer) => void, thisArg?: any): void
Parameter Description callbackfn: (item: DataTransferItem, mimeType: string, dataTransfer: DataTransfer) => void thisArg?: any Returns Description voidget(mimeType: string): DataTransferItem
set(mimeType: string, value: DataTransferItem): void
Parameter Description mimeType: string value: DataTransferItem Returns Description void DataTransferFile Propertiesuri?: Uri
Methods Parameter Description Returns Description Thenable<Uint8Array> DataTransferItem Constructorsnew DataTransferItem(value: any): DataTransferItem
Properties MethodsasFile(): DataTransferFile
Parameter Description Returns Description Thenable<string> DebugAdapter EventsonDidSendMessage: Event<DebugProtocolMessage>
Methods Parameter Description Returns Description anyhandleMessage(message: DebugProtocolMessage): void
DebugAdapterDescriptorDebugAdapterDescriptor: DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation
DebugAdapterDescriptorFactory MethodscreateDebugAdapterDescriptor(session: DebugSession, executable: DebugAdapterExecutable): ProviderResult<DebugAdapterDescriptor>
DebugAdapterExecutable Constructorsnew DebugAdapterExecutable(command: string, args?: string[], options?: DebugAdapterExecutableOptions): DebugAdapterExecutable
Propertiesoptions?: DebugAdapterExecutableOptions
DebugAdapterExecutableOptions Properties DebugAdapterInlineImplementation Constructorsnew DebugAdapterInlineImplementation(implementation: DebugAdapter): DebugAdapterInlineImplementation
DebugAdapterNamedPipeServer Constructorsnew DebugAdapterNamedPipeServer(path: string): DebugAdapterNamedPipeServer
Properties DebugAdapterServer Constructorsnew DebugAdapterServer(port: number, host?: string): DebugAdapterServer
Properties DebugAdapterTracker EventsonDidSendMessage(message: any): void
Parameter Description message: any Returns Description voidonWillReceiveMessage(message: any): void
Parameter Description message: any Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void Methods Parameter Description error: Error Returns Description voidonExit(code: number, signal: string): void
Parameter Description code: number signal: string Returns Description void DebugAdapterTrackerFactory MethodscreateDebugAdapterTracker(session: DebugSession): ProviderResult<DebugAdapterTracker>
DebugConfiguration Properties DebugConfigurationProvider MethodsprovideDebugConfigurations(folder: WorkspaceFolder, token?: CancellationToken): ProviderResult<DebugConfiguration[]>
resolveDebugConfiguration(folder: WorkspaceFolder, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>
resolveDebugConfigurationWithSubstitutedVariables(folder: WorkspaceFolder, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>
DebugConfigurationProviderTriggerKind Enumeration Members DebugConsole Methods Parameter Description value: string Returns Description voidappendLine(value: string): void
Parameter Description value: string Returns Description void DebugConsoleMode Enumeration Members DebugProtocolBreakpoint DebugProtocolMessage DebugProtocolSource DebugSession Propertiesconfiguration: DebugConfiguration
parentSession?: DebugSession
workspaceFolder: WorkspaceFolder
MethodscustomRequest(command: string, args?: any): Thenable<any>
Parameter Description command: string args?: any Returns Description Thenable<any>getDebugProtocolBreakpoint(breakpoint: Breakpoint): Thenable<DebugProtocolBreakpoint>
DebugSessionCustomEvent Propertiessession: DebugSession
DebugSessionOptions PropertiesconsoleMode?: DebugConsoleMode
lifecycleManagedByParent?: boolean
parentSession?: DebugSession
suppressDebugStatusbar?: boolean
suppressDebugToolbar?: boolean
suppressSaveBeforeStart?: boolean
testRun?: TestRun
DebugStackFrame Propertiessession: DebugSession
DebugThread Propertiessession: DebugSession
DeclarationDeclaration: Location | Location[] | LocationLink[]
DeclarationCoverage Constructorsnew DeclarationCoverage(name: string, executed: number | boolean, location: Range | Position): DeclarationCoverage
Properties DeclarationProvider MethodsprovideDeclaration(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Declaration>
DecorationInstanceRenderOptions Propertiesafter?: ThemableDecorationAttachmentRenderOptions
before?: ThemableDecorationAttachmentRenderOptions
dark?: ThemableDecorationInstanceRenderOptions
light?: ThemableDecorationInstanceRenderOptions
DecorationOptions PropertieshoverMessage?: MarkdownString | MarkedString | Array<MarkdownString | MarkedString>
range: Range
renderOptions?: DecorationInstanceRenderOptions
DecorationRangeBehavior Enumeration Members DecorationRenderOptions Propertiesafter?: ThemableDecorationAttachmentRenderOptions
backgroundColor?: string | ThemeColor
before?: ThemableDecorationAttachmentRenderOptions
borderColor?: string | ThemeColor
color?: string | ThemeColor
dark?: ThemableDecorationRenderOptions
gutterIconPath?: string | Uri
light?: ThemableDecorationRenderOptions
outlineColor?: string | ThemeColor
overviewRulerColor?: string | ThemeColor
overviewRulerLane?: OverviewRulerLane
rangeBehavior?: DecorationRangeBehavior
DefinitionDefinition: Location | Location[]
DefinitionLinkDefinitionLink: LocationLink
DefinitionProvider MethodsprovideDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>
Diagnostic Constructorsnew Diagnostic(range: Range, message: string, severity?: DiagnosticSeverity): Diagnostic
Propertiescode?: string | number | {target: Uri, value: string | number}
range: Range
relatedInformation?: DiagnosticRelatedInformation[]
severity: DiagnosticSeverity
tags?: DiagnosticTag[]
DiagnosticChangeEvent Propertiesuris: readonly Uri[]
DiagnosticCollection Properties Methods Parameter Description Returns Description voiddelete(uri: Uri): void
Parameter Description uri: Uri Returns Description void Parameter Description Returns Description voidforEach(callback: (uri: Uri, diagnostics: readonly Diagnostic[], collection: DiagnosticCollection) => any, thisArg?: any): void
get(uri: Uri): readonly Diagnostic[]
Parameter Description uri: Uri Returns Description readonly Diagnostic[]has(uri: Uri): boolean
Parameter Description uri: Uri Returns Description booleanset(uri: Uri, diagnostics: readonly Diagnostic[]): void
Parameter Description uri: Uri diagnostics: readonly Diagnostic[] Returns Description voidset(entries: ReadonlyArray<[Uri, readonly Diagnostic[]]>): void
Parameter Description entries: ReadonlyArray<[Uri, readonly Diagnostic[]]> Returns Description void Constructorsnew DiagnosticRelatedInformation(location: Location, message: string): DiagnosticRelatedInformation
Propertieslocation: Location
DiagnosticSeverity Enumeration Members DiagnosticTag Enumeration Members Disposable Staticfrom(...disposableLikes: Array<{dispose: () => any}>): Disposable
Parameter Description ...disposableLikes: Array<{dispose: () => any}> Returns Description Disposable Constructorsnew Disposable(callOnDispose: () => any): Disposable
Parameter Description callOnDispose: () => any Returns Description Disposable Methods Parameter Description Returns Description any DocumentColorProvider MethodsprovideColorPresentations(color: Color, context: {document: TextDocument, range: Range}, token: CancellationToken): ProviderResult<ColorPresentation[]>
provideDocumentColors(document: TextDocument, token: CancellationToken): ProviderResult<ColorInformation[]>
DocumentDropEdit Constructorsnew DocumentDropEdit(insertText: string | SnippetString, title?: string, kind?: DocumentDropOrPasteEditKind): DocumentDropEdit
PropertiesadditionalEdit?: WorkspaceEdit
insertText: string | SnippetString
kind?: DocumentDropOrPasteEditKind
yieldTo?: readonly DocumentDropOrPasteEditKind[]
DocumentDropEditProvider<T> MethodsprovideDocumentDropEdits(document: TextDocument, position: Position, dataTransfer: DataTransfer, token: CancellationToken): ProviderResult<T | T[]>
resolveDocumentDropEdit(edit: T, token: CancellationToken): ProviderResult<T>
DocumentDropEditProviderMetadata PropertiesdropMimeTypes: readonly string[]
providedDropEditKinds?: readonly DocumentDropOrPasteEditKind[]
DocumentDropOrPasteEditKind StaticEmpty: DocumentDropOrPasteEditKind
Text: DocumentDropOrPasteEditKind
TextUpdateImports: DocumentDropOrPasteEditKind
Constructorsnew DocumentDropOrPasteEditKind(value: string): DocumentDropOrPasteEditKind
Properties Methodsappend(...parts: string[]): DocumentDropOrPasteEditKind
contains(other: DocumentDropOrPasteEditKind): boolean
intersects(other: DocumentDropOrPasteEditKind): boolean
DocumentFilter Propertiespattern?: GlobPattern
DocumentFormattingEditProvider MethodsprovideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>
DocumentHighlight Constructorsnew DocumentHighlight(range: Range, kind?: DocumentHighlightKind): DocumentHighlight
Propertieskind?: DocumentHighlightKind
range: Range
DocumentHighlightKind Enumeration Members DocumentHighlightProvider MethodsprovideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>
DocumentLink Constructorsnew DocumentLink(range: Range, target?: Uri): DocumentLink
Propertiesrange: Range
target?: Uri
DocumentLinkProvider<T> MethodsprovideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<T[]>
resolveDocumentLink(link: T, token: CancellationToken): ProviderResult<T>
DocumentPasteEdit Constructorsnew DocumentPasteEdit(insertText: string | SnippetString, title: string, kind: DocumentDropOrPasteEditKind): DocumentPasteEdit
PropertiesadditionalEdit?: WorkspaceEdit
insertText: string | SnippetString
kind: DocumentDropOrPasteEditKind
yieldTo?: readonly DocumentDropOrPasteEditKind[]
DocumentPasteEditContext Propertiesonly: DocumentDropOrPasteEditKind
triggerKind: DocumentPasteTriggerKind
DocumentPasteEditProvider<T> MethodsprepareDocumentPaste(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>
provideDocumentPasteEdits(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, context: DocumentPasteEditContext, token: CancellationToken): ProviderResult<T[]>
resolveDocumentPasteEdit(pasteEdit: T, token: CancellationToken): ProviderResult<T>
DocumentPasteProviderMetadata PropertiescopyMimeTypes?: readonly string[]
pasteMimeTypes?: readonly string[]
providedPasteEditKinds: readonly DocumentDropOrPasteEditKind[]
DocumentPasteTriggerKind Enumeration Members DocumentRangeFormattingEditProvider MethodsprovideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>
provideDocumentRangesFormattingEdits(document: TextDocument, ranges: Range[], options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>
DocumentRangeSemanticTokensProvider MethodsprovideDocumentRangeSemanticTokens(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<SemanticTokens>
DocumentSelectorDocumentSelector: DocumentFilter | string | ReadonlyArray<DocumentFilter | string>
DocumentSemanticTokensProvider EventsonDidChangeSemanticTokens?: Event<void>
MethodsprovideDocumentSemanticTokens(document: TextDocument, token: CancellationToken): ProviderResult<SemanticTokens>
provideDocumentSemanticTokensEdits(document: TextDocument, previousResultId: string, token: CancellationToken): ProviderResult<SemanticTokens | SemanticTokensEdits>
DocumentSymbol Constructorsnew DocumentSymbol(name: string, detail: string, kind: SymbolKind, range: Range, selectionRange: Range): DocumentSymbol
Propertieschildren: DocumentSymbol[]
kind: SymbolKind
range: Range
selectionRange: Range
tags?: readonly SymbolTag[]
DocumentSymbolProvider MethodsprovideDocumentSymbols(document: TextDocument, token: CancellationToken): ProviderResult<DocumentSymbol[] | SymbolInformation[]>
DocumentSymbolProviderMetadata Properties EndOfLine Enumeration Members EnterAction PropertiesindentAction: IndentAction
EnvironmentVariableCollection Propertiesdescription: string | MarkdownString
Methodsappend(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
Parameter Description Returns Description voiddelete(variable: string): void
Parameter Description variable: string Returns Description voidforEach(callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any, thisArg?: any): void
get(variable: string): EnvironmentVariableMutator
prepend(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
replace(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
EnvironmentVariableMutator Propertiesoptions: EnvironmentVariableMutatorOptions
type: EnvironmentVariableMutatorType
EnvironmentVariableMutatorOptions PropertiesapplyAtProcessCreation?: boolean
applyAtShellIntegration?: boolean
EnvironmentVariableMutatorType Enumeration Members EnvironmentVariableScope PropertiesworkspaceFolder?: WorkspaceFolder
EvaluatableExpression Constructorsnew EvaluatableExpression(range: Range, expression?: string): EvaluatableExpression
Propertiesrange: Range
EvaluatableExpressionProvider MethodsprovideEvaluatableExpression(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<EvaluatableExpression>
Event<T>(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable
Parameter Description listener: (e: T) => any thisArgs?: any disposables?: Disposable[] Returns Description Disposable EventEmitter<T> Constructorsnew EventEmitter<T>(): EventEmitter<T>
Propertiesevent: Event<T>
Methods Parameter Description Returns Description void Parameter Description data: T Returns Description void Extension<T> PropertiesextensionKind: ExtensionKind
extensionUri: Uri
Methods Parameter Description Returns Description Thenable<T> ExtensionContext PropertiesenvironmentVariableCollection: GlobalEnvironmentVariableCollection
extension: Extension<any>
extensionMode: ExtensionMode
extensionUri: Uri
globalState: Memento & {setKeysForSync}
globalStorageUri: Uri
languageModelAccessInformation: LanguageModelAccessInformation
logUri: Uri
secrets: SecretStorage
storageUri: Uri
subscriptions: Array<{dispose}>
workspaceState: Memento
MethodsasAbsolutePath(relativePath: string): string
Parameter Description relativePath: string Returns Description string ExtensionKind Enumeration Members ExtensionMode Enumeration Members ExtensionTerminalOptions Propertiescolor?: ThemeColor
iconPath?: IconPath
location?: TerminalEditorLocationOptions | TerminalSplitLocationOptions | TerminalLocation
pty: Pseudoterminal
FileChangeEvent Propertiestype: FileChangeType
uri: Uri
FileChangeType Enumeration Members FileCoverage StaticfromDetails(uri: Uri, details: readonly FileCoverageDetail[]): FileCoverage
Constructorsnew FileCoverage(uri: Uri, statementCoverage: TestCoverageCount, branchCoverage?: TestCoverageCount, declarationCoverage?: TestCoverageCount, includesTests?: TestItem[]): FileCoverage
PropertiesbranchCoverage?: TestCoverageCount
declarationCoverage?: TestCoverageCount
includesTests?: TestItem[]
statementCoverage: TestCoverageCount
uri: Uri
FileCoverageDetailFileCoverageDetail: StatementCoverage | DeclarationCoverage
FileCreateEvent Propertiesfiles: readonly Uri[]
FileDecoration Constructorsnew FileDecoration(badge?: string, tooltip?: string, color?: ThemeColor): FileDecoration
Propertiescolor?: ThemeColor
FileDecorationProvider EventsonDidChangeFileDecorations?: Event<Uri | Uri[]>
MethodsprovideFileDecoration(uri: Uri, token: CancellationToken): ProviderResult<FileDecoration>
FileDeleteEvent Propertiesfiles: readonly Uri[]
FilePermission Enumeration Members FileRenameEvent Propertiesfiles: ReadonlyArray<{newUri: Uri, oldUri: Uri}>
FileStat Propertiespermissions?: FilePermission
type: FileType
FileSystem Methodscopy(source: Uri, target: Uri, options?: {overwrite: boolean}): Thenable<void>
Parameter Description source: Uri target: Uri options?: {overwrite: boolean} Returns Description Thenable<void>createDirectory(uri: Uri): Thenable<void>
Parameter Description uri: Uri Returns Description Thenable<void>delete(uri: Uri, options?: {recursive: boolean, useTrash: boolean}): Thenable<void>
Parameter Description uri: Uri options?: {recursive: boolean, useTrash: boolean} Returns Description Thenable<void>isWritableFileSystem(scheme: string): boolean
Parameter Description scheme: string Returns Description booleanreadDirectory(uri: Uri): Thenable<Array<[string, FileType]>>
Parameter Description uri: Uri Returns Description Thenable<Array<[string, FileType]>>readFile(uri: Uri): Thenable<Uint8Array>
Parameter Description uri: Uri Returns Description Thenable<Uint8Array>rename(source: Uri, target: Uri, options?: {overwrite: boolean}): Thenable<void>
Parameter Description source: Uri target: Uri options?: {overwrite: boolean} Returns Description Thenable<void>stat(uri: Uri): Thenable<FileStat>
Parameter Description uri: Uri Returns Description Thenable<FileStat>writeFile(uri: Uri, content: Uint8Array): Thenable<void>
Parameter Description uri: Uri content: Uint8Array Returns Description Thenable<void> FileSystemError StaticFileExists(messageOrUri?: string | Uri): FileSystemError
FileIsADirectory(messageOrUri?: string | Uri): FileSystemError
FileNotADirectory(messageOrUri?: string | Uri): FileSystemError
FileNotFound(messageOrUri?: string | Uri): FileSystemError
NoPermissions(messageOrUri?: string | Uri): FileSystemError
Unavailable(messageOrUri?: string | Uri): FileSystemError
Constructorsnew FileSystemError(messageOrUri?: string | Uri): FileSystemError
Properties FileSystemProvider EventsonDidChangeFile: Event<FileChangeEvent[]>
Methodscopy(source: Uri, destination: Uri, options: {overwrite: boolean}): void | Thenable<void>
Parameter Description source: Uri destination: Uri options: {overwrite: boolean} Returns Description void | Thenable<void>createDirectory(uri: Uri): void | Thenable<void>
Parameter Description uri: Uri Returns Description void | Thenable<void>delete(uri: Uri, options: {recursive: boolean}): void | Thenable<void>
Parameter Description uri: Uri options: {recursive: boolean} Returns Description void | Thenable<void>readDirectory(uri: Uri): Array<[string, FileType]> | Thenable<Array<[string, FileType]>>
Parameter Description uri: Uri Returns Description Array<[string, FileType]> | Thenable<Array<[string, FileType]>>readFile(uri: Uri): Uint8Array | Thenable<Uint8Array>
Parameter Description uri: Uri Returns Description Uint8Array | Thenable<Uint8Array>rename(oldUri: Uri, newUri: Uri, options: {overwrite: boolean}): void | Thenable<void>
Parameter Description oldUri: Uri newUri: Uri options: {overwrite: boolean} Returns Description void | Thenable<void>stat(uri: Uri): FileStat | Thenable<FileStat>
watch(uri: Uri, options: {excludes: readonly string[], recursive: boolean}): Disposable
Parameter Description uri: Uri options: {excludes: readonly string[], recursive: boolean} Returns Description DisposablewriteFile(uri: Uri, content: Uint8Array, options: {create: boolean, overwrite: boolean}): void | Thenable<void>
Parameter Description uri: Uri content: Uint8Array options: {create: boolean, overwrite: boolean} Returns Description void | Thenable<void> FileSystemWatcher Events Properties Methods Parameter Description Returns Description any FileType Enumeration Members FileWillCreateEvent Propertiesfiles: readonly Uri[]
token: CancellationToken
MethodswaitUntil(thenable: Thenable<WorkspaceEdit>): void
Parameter Description thenable: Thenable<WorkspaceEdit> Returns Description voidwaitUntil(thenable: Thenable<any>): void
Parameter Description thenable: Thenable<any> Returns Description void FileWillDeleteEvent Propertiesfiles: readonly Uri[]
token: CancellationToken
MethodswaitUntil(thenable: Thenable<WorkspaceEdit>): void
Parameter Description thenable: Thenable<WorkspaceEdit> Returns Description voidwaitUntil(thenable: Thenable<any>): void
Parameter Description thenable: Thenable<any> Returns Description void FileWillRenameEvent Propertiesfiles: ReadonlyArray<{newUri: Uri, oldUri: Uri}>
token: CancellationToken
MethodswaitUntil(thenable: Thenable<WorkspaceEdit>): void
Parameter Description thenable: Thenable<WorkspaceEdit> Returns Description voidwaitUntil(thenable: Thenable<any>): void
Parameter Description thenable: Thenable<any> Returns Description void FoldingContext FoldingRange Constructorsnew FoldingRange(start: number, end: number, kind?: FoldingRangeKind): FoldingRange
Propertieskind?: FoldingRangeKind
FoldingRangeKind Enumeration Members FoldingRangeProvider EventsonDidChangeFoldingRanges?: Event<void>
MethodsprovideFoldingRanges(document: TextDocument, context: FoldingContext, token: CancellationToken): ProviderResult<FoldingRange[]>
FormattingOptions Properties FunctionBreakpoint Constructorsnew FunctionBreakpoint(functionName: string, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string): FunctionBreakpoint
Parameter Description functionName: string enabled?: boolean condition?: string hitCondition?: string logMessage?: string Returns Description FunctionBreakpoint Properties GlobalEnvironmentVariableCollection Propertiesdescription: string | MarkdownString
Methodsappend(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
Parameter Description Returns Description voiddelete(variable: string): void
Parameter Description variable: string Returns Description voidforEach(callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any, thisArg?: any): void
get(variable: string): EnvironmentVariableMutator
getScoped(scope: EnvironmentVariableScope): EnvironmentVariableCollection
prepend(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
replace(variable: string, value: string, options?: EnvironmentVariableMutatorOptions): void
GlobPatternGlobPattern: string | RelativePattern
Hover Constructorsnew Hover(contents: MarkdownString | MarkedString | Array<MarkdownString | MarkedString>, range?: Range): Hover
Propertiescontents: Array<MarkdownString | MarkedString>
range?: Range
HoverProvider MethodsprovideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>
IconPathIconPath: Uri | {dark: Uri, light: Uri} | ThemeIcon
ImplementationProvider MethodsprovideImplementation(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>
IndentAction Enumeration Members IndentationRule PropertiesindentNextLinePattern?: RegExp
unIndentedLinePattern?: RegExp
InlayHint Constructorsnew InlayHint(position: Position, label: string | InlayHintLabelPart[], kind?: InlayHintKind): InlayHint
Propertieskind?: InlayHintKind
label: string | InlayHintLabelPart[]
position: Position
textEdits?: TextEdit[]
tooltip?: string | MarkdownString
InlayHintKind Enumeration Members InlayHintLabelPart Constructorsnew InlayHintLabelPart(value: string): InlayHintLabelPart
Propertiescommand?: Command
location?: Location
tooltip?: string | MarkdownString
InlayHintsProvider<T> EventsonDidChangeInlayHints?: Event<void>
MethodsprovideInlayHints(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<T[]>
resolveInlayHint(hint: T, token: CancellationToken): ProviderResult<T>
InlineCompletionContext PropertiesselectedCompletionInfo: SelectedCompletionInfo
triggerKind: InlineCompletionTriggerKind
InlineCompletionItem Constructorsnew InlineCompletionItem(insertText: string | SnippetString, range?: Range, command?: Command): InlineCompletionItem
Propertiescommand?: Command
insertText: string | SnippetString
range?: Range
InlineCompletionItemProvider MethodsprovideInlineCompletionItems(document: TextDocument, position: Position, context: InlineCompletionContext, token: CancellationToken): ProviderResult<InlineCompletionList | InlineCompletionItem[]>
InlineCompletionList Constructorsnew InlineCompletionList(items: InlineCompletionItem[]): InlineCompletionList
Propertiesitems: InlineCompletionItem[]
InlineCompletionTriggerKind Enumeration Members InlineValueInlineValue: InlineValueText | InlineValueVariableLookup | InlineValueEvaluatableExpression
InlineValueContext PropertiesstoppedLocation: Range
InlineValueEvaluatableExpression Constructorsnew InlineValueEvaluatableExpression(range: Range, expression?: string): InlineValueEvaluatableExpression
Propertiesrange: Range
InlineValuesProvider EventsonDidChangeInlineValues?: Event<void>
MethodsprovideInlineValues(document: TextDocument, viewPort: Range, context: InlineValueContext, token: CancellationToken): ProviderResult<InlineValue[]>
InlineValueText Constructorsnew InlineValueText(range: Range, text: string): InlineValueText
Propertiesrange: Range
InlineValueVariableLookup Constructorsnew InlineValueVariableLookup(range: Range, variableName?: string, caseSensitiveLookup?: boolean): InlineValueVariableLookup
Propertiesrange: Range
InputBox EventsonDidAccept: Event<void>
onDidChangeValue: Event<string>
onDidHide: Event<void>
onDidTriggerButton: Event<QuickInputButton>
Propertiesbuttons: readonly QuickInputButton[]
validationMessage: string | InputBoxValidationMessage
valueSelection: readonly [number, number]
Methods Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void InputBoxOptions PropertiesvalueSelection?: [number, number]
MethodsvalidateInput(value: string): string | InputBoxValidationMessage | Thenable<string | InputBoxValidationMessage>
InputBoxValidationMessage Propertiesseverity: InputBoxValidationSeverity
InputBoxValidationSeverity Enumeration Members LanguageConfiguration Properties__characterPairSupport?: {autoClosingPairs: Array<{close: string, notIn: string[], open: string}>}
Parameter Description autoClosingPairs: Array<{close: string, notIn: string[], open: string}>__electricCharacterSupport?: {brackets: any, docComment: {close: string, lineStart: string, open: string, scope: string}}
Parameter Description brackets: any docComment: {close: string, lineStart: string, open: string, scope: string}autoClosingPairs?: AutoClosingPair[]
brackets?: CharacterPair[]
comments?: CommentRule
indentationRules?: IndentationRule
onEnterRules?: OnEnterRule[]
LanguageModelAccessInformation EventsonDidChange: Event<void>
MethodscanSendRequest(chat: LanguageModelChat): boolean
LanguageModelChat Properties MethodscountTokens(text: string | LanguageModelChatMessage, token?: CancellationToken): Thenable<number>
sendRequest(messages: LanguageModelChatMessage[], options?: LanguageModelChatRequestOptions, token?: CancellationToken): Thenable<LanguageModelChatResponse>
LanguageModelChatMessage StaticAssistant(content: string | Array<LanguageModelTextPart | LanguageModelToolCallPart>, name?: string): LanguageModelChatMessage
User(content: string | Array<LanguageModelTextPart | LanguageModelToolResultPart>, name?: string): LanguageModelChatMessage
Constructorsnew LanguageModelChatMessage(role: LanguageModelChatMessageRole, content: string | Array<LanguageModelTextPart | LanguageModelToolResultPart | LanguageModelToolCallPart>, name?: string): LanguageModelChatMessage
Propertiescontent: Array<LanguageModelTextPart | LanguageModelToolResultPart | LanguageModelToolCallPart>
role: LanguageModelChatMessageRole
LanguageModelChatMessageRole Enumeration Members LanguageModelChatRequestOptions PropertiestoolMode?: LanguageModelChatToolMode
tools?: LanguageModelChatTool[]
LanguageModelChatResponse Propertiesstream: AsyncIterable<unknown>
LanguageModelChatSelector Properties LanguageModelChatTool Properties LanguageModelChatToolMode Enumeration Members LanguageModelError StaticBlocked(message?: string): LanguageModelError
NoPermissions(message?: string): LanguageModelError
NotFound(message?: string): LanguageModelError
Constructorsnew LanguageModelError(message?: string): LanguageModelError
Properties LanguageModelPromptTsxPart Constructorsnew LanguageModelPromptTsxPart(value: unknown): LanguageModelPromptTsxPart
Properties LanguageModelTextPart Constructorsnew LanguageModelTextPart(value: string): LanguageModelTextPart
Properties LanguageModelTool<T> Methodsinvoke(options: LanguageModelToolInvocationOptions<T>, token: CancellationToken): ProviderResult<LanguageModelToolResult>
prepareInvocation(options: LanguageModelToolInvocationPrepareOptions<T>, token: CancellationToken): ProviderResult<PreparedToolInvocation>
LanguageModelToolCallPart Constructorsnew LanguageModelToolCallPart(callId: string, name: string, input: object): LanguageModelToolCallPart
Properties LanguageModelToolConfirmationMessages Propertiesmessage: string | MarkdownString
LanguageModelToolInformation Properties LanguageModelToolInvocationOptions<T> PropertiestokenizationOptions?: LanguageModelToolTokenizationOptions
toolInvocationToken: undefined
LanguageModelToolInvocationPrepareOptions<T> Properties LanguageModelToolResult Constructorsnew LanguageModelToolResult(content: Array<LanguageModelTextPart | LanguageModelPromptTsxPart>): LanguageModelToolResult
Properties LanguageModelToolResultPart Constructorsnew LanguageModelToolResultPart(callId: string, content: unknown[]): LanguageModelToolResultPart
Properties LanguageModelToolTokenizationOptions Properties MethodscountTokens(text: string, token?: CancellationToken): Thenable<number>
Parameter Description text: string token?: CancellationToken Returns Description Thenable<number> LanguageStatusItem PropertiesaccessibilityInformation?: AccessibilityInformation
command: Command
selector: DocumentSelector
severity: LanguageStatusSeverity
Methods Parameter Description Returns Description void LanguageStatusSeverity Enumeration Members LinkedEditingRangeProvider MethodsprovideLinkedEditingRanges(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<LinkedEditingRanges>
LinkedEditingRanges Constructorsnew LinkedEditingRanges(ranges: Range[], wordPattern?: RegExp): LinkedEditingRanges
Propertiesranges: Range[]
Location Constructorsnew Location(uri: Uri, rangeOrPosition: Range | Position): Location
Propertiesrange: Range
uri: Uri
LocationLink PropertiesoriginSelectionRange?: Range
targetRange: Range
targetSelectionRange?: Range
targetUri: Uri
LogLevel Enumeration Members LogOutputChannel EventsonDidChangeLogLevel: Event<LogLevel>
PropertieslogLevel: LogLevel
Methods Parameter Description value: string Returns Description voidappendLine(value: string): void
Parameter Description value: string Returns Description void Parameter Description Returns Description voiddebug(message: string, ...args: any[]): void
Parameter Description message: string ...args: any[] Returns Description void Parameter Description Returns Description voiderror(error: string | Error, ...args: any[]): void
Parameter Description error: string | Error ...args: any[] Returns Description void Parameter Description Returns Description voidinfo(message: string, ...args: any[]): void
Parameter Description message: string ...args: any[] Returns Description void Parameter Description value: string Returns Description voidshow(preserveFocus?: boolean): void
Parameter Description preserveFocus?: boolean Returns Description voidshow(column?: ViewColumn, preserveFocus?: boolean): void
Parameter Description column?: ViewColumn preserveFocus?: boolean Returns Description voidtrace(message: string, ...args: any[]): void
Parameter Description message: string ...args: any[] Returns Description voidwarn(message: string, ...args: any[]): void
Parameter Description message: string ...args: any[] Returns Description void MarkdownString Constructorsnew MarkdownString(value?: string, supportThemeIcons?: boolean): MarkdownString
Parameter Description value?: string supportThemeIcons?: boolean Returns Description MarkdownString PropertiesbaseUri?: Uri
isTrusted?: boolean | {enabledCommands: readonly string[]}
MethodsappendCodeblock(value: string, language?: string): MarkdownString
Parameter Description value: string language?: string Returns Description MarkdownStringappendMarkdown(value: string): MarkdownString
Parameter Description value: string Returns Description MarkdownStringappendText(value: string): MarkdownString
Parameter Description value: string Returns Description MarkdownString MarkedStringMarkedString: string | {language: string, value: string}
McpHttpServerDefinition Constructorsnew McpHttpServerDefinition(label: string, uri: Uri, headers?: Record<string, string>, version?: string): McpHttpServerDefinition
Parameter Description label: string uri: Uri headers?: Record<string, string> version?: string Returns Description McpHttpServerDefinition Propertiesheaders: Record<string, string>
uri: Uri
McpServerDefinitionMcpServerDefinition: McpStdioServerDefinition | McpHttpServerDefinition
McpServerDefinitionProvider<T> EventsonDidChangeMcpServerDefinitions?: Event<void>
MethodsprovideMcpServerDefinitions(token: CancellationToken): ProviderResult<T[]>
resolveMcpServerDefinition(server: T, token: CancellationToken): ProviderResult<T>
McpStdioServerDefinition Constructorsnew McpStdioServerDefinition(label: string, command: string, args?: string[], env?: Record<string, string | number>, version?: string): McpStdioServerDefinition
Parameter Description label: string command: string args?: string[] env?: Record<string, string | number> version?: string Returns Description McpStdioServerDefinition Propertiescwd?: Uri
env: Record<string, string | number>
Memento Methods Parameter Description key: string Returns Description Tget<T>(key: string, defaultValue: T): T
Parameter Description key: string defaultValue: T Returns Description T Parameter Description Returns Description readonly string[]update(key: string, value: any): Thenable<void>
Parameter Description key: string value: any Returns Description Thenable<void> MessageItem Properties MessageOptions Properties NotebookCell Propertiesdocument: TextDocument
executionSummary: NotebookCellExecutionSummary
kind: NotebookCellKind
notebook: NotebookDocument
outputs: readonly NotebookCellOutput[]
NotebookCellData Constructorsnew NotebookCellData(kind: NotebookCellKind, value: string, languageId: string): NotebookCellData
PropertiesexecutionSummary?: NotebookCellExecutionSummary
kind: NotebookCellKind
outputs?: NotebookCellOutput[]
NotebookCellExecution Propertiescell: NotebookCell
token: CancellationToken
MethodsappendOutput(out: NotebookCellOutput | readonly NotebookCellOutput[], cell?: NotebookCell): Thenable<void>
appendOutputItems(items: NotebookCellOutputItem | readonly NotebookCellOutputItem[], output: NotebookCellOutput): Thenable<void>
clearOutput(cell?: NotebookCell): Thenable<void>
Parameter Description cell?: NotebookCell Returns Description Thenable<void>end(success: boolean, endTime?: number): void
Parameter Description success: boolean endTime?: number Returns Description voidreplaceOutput(out: NotebookCellOutput | readonly NotebookCellOutput[], cell?: NotebookCell): Thenable<void>
replaceOutputItems(items: NotebookCellOutputItem | readonly NotebookCellOutputItem[], output: NotebookCellOutput): Thenable<void>
start(startTime?: number): void
Parameter Description startTime?: number Returns Description void NotebookCellExecutionSummary Propertiestiming?: {endTime: number, startTime: number}
Parameter Description endTime: number startTime: number NotebookCellKind Enumeration Members NotebookCellOutput Constructorsnew NotebookCellOutput(items: NotebookCellOutputItem[], metadata?: ): NotebookCellOutput
Propertiesitems: NotebookCellOutputItem[]
NotebookCellOutputItem Staticerror(value: Error): NotebookCellOutputItem
json(value: any, mime?: string): NotebookCellOutputItem
stderr(value: string): NotebookCellOutputItem
stdout(value: string): NotebookCellOutputItem
text(value: string, mime?: string): NotebookCellOutputItem
Constructorsnew NotebookCellOutputItem(data: Uint8Array, mime: string): NotebookCellOutputItem
Properties NotebookCellStatusBarAlignment Enumeration Members NotebookCellStatusBarItem Constructorsnew NotebookCellStatusBarItem(text: string, alignment: NotebookCellStatusBarAlignment): NotebookCellStatusBarItem
PropertiesaccessibilityInformation?: AccessibilityInformation
alignment: NotebookCellStatusBarAlignment
command?: string | Command
NotebookCellStatusBarItemProvider EventsonDidChangeCellStatusBarItems?: Event<void>
MethodsprovideCellStatusBarItems(cell: NotebookCell, token: CancellationToken): ProviderResult<NotebookCellStatusBarItem | NotebookCellStatusBarItem[]>
NotebookController EventsonDidChangeSelectedNotebooks: Event<{notebook: NotebookDocument, selected: boolean}>
PropertiesexecuteHandler: (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController) => void | Thenable<void>
interruptHandler?: (notebook: NotebookDocument) => void | Thenable<void>
Parameter Description notebook: NotebookDocument Returns Description void | Thenable<void>supportsExecutionOrder?: boolean
MethodscreateNotebookCellExecution(cell: NotebookCell): NotebookCellExecution
Parameter Description Returns Description voidupdateNotebookAffinity(notebook: NotebookDocument, affinity: NotebookControllerAffinity): void
NotebookControllerAffinity Enumeration Members NotebookData Constructorsnew NotebookData(cells: NotebookCellData[]): NotebookData
Propertiescells: NotebookCellData[]
NotebookDocument Propertiesuri: Uri
MethodscellAt(index: number): NotebookCell
Parameter Description index: number Returns Description NotebookCellgetCells(range?: NotebookRange): NotebookCell[]
Parameter Description Returns Description Thenable<boolean> NotebookDocumentCellChange Propertiescell: NotebookCell
document: TextDocument
executionSummary: NotebookCellExecutionSummary
outputs: readonly NotebookCellOutput[]
NotebookDocumentChangeEvent PropertiescellChanges: readonly NotebookDocumentCellChange[]
contentChanges: readonly NotebookDocumentContentChange[]
notebook: NotebookDocument
NotebookDocumentContentChange PropertiesaddedCells: readonly NotebookCell[]
range: NotebookRange
removedCells: readonly NotebookCell[]
NotebookDocumentContentOptions Properties NotebookDocumentShowOptions Propertiesselections?: readonly NotebookRange[]
viewColumn?: ViewColumn
NotebookDocumentWillSaveEvent Propertiesnotebook: NotebookDocument
reason: TextDocumentSaveReason
token: CancellationToken
MethodswaitUntil(thenable: Thenable<WorkspaceEdit>): void
Parameter Description thenable: Thenable<WorkspaceEdit> Returns Description voidwaitUntil(thenable: Thenable<any>): void
Parameter Description thenable: Thenable<any> Returns Description void NotebookEdit StaticdeleteCells(range: NotebookRange): NotebookEdit
insertCells(index: number, newCells: NotebookCellData[]): NotebookEdit
replaceCells(range: NotebookRange, newCells: NotebookCellData[]): NotebookEdit
updateCellMetadata(index: number, newCellMetadata: ): NotebookEdit
Parameter Description index: number newCellMetadata: Returns Description NotebookEditupdateNotebookMetadata(newNotebookMetadata: ): NotebookEdit
Parameter Description newNotebookMetadata: Returns Description NotebookEdit Constructorsnew NotebookEdit(range: NotebookRange, newCells: NotebookCellData[]): NotebookEdit
PropertiesnewCells: NotebookCellData[]
range: NotebookRange
NotebookEditor Propertiesnotebook: NotebookDocument
selection: NotebookRange
selections: readonly NotebookRange[]
viewColumn?: ViewColumn
visibleRanges: readonly NotebookRange[]
MethodsrevealRange(range: NotebookRange, revealType?: NotebookEditorRevealType): void
NotebookEditorRevealType Enumeration Members NotebookEditorSelectionChangeEvent PropertiesnotebookEditor: NotebookEditor
selections: readonly NotebookRange[]
NotebookEditorVisibleRangesChangeEvent PropertiesnotebookEditor: NotebookEditor
visibleRanges: readonly NotebookRange[]
NotebookRange Constructorsnew NotebookRange(start: number, end: number): NotebookRange
Parameter Description start: number end: number Returns Description NotebookRange Properties Methodswith(change: {end: number, start: number}): NotebookRange
Parameter Description change: {end: number, start: number} Returns Description NotebookRange NotebookRendererMessaging EventsonDidReceiveMessage: Event<{editor: NotebookEditor, message: any}>
MethodspostMessage(message: any, editor?: NotebookEditor): Thenable<boolean>
Parameter Description message: any editor?: NotebookEditor Returns Description Thenable<boolean> NotebookSerializer MethodsdeserializeNotebook(content: Uint8Array, token: CancellationToken): NotebookData | Thenable<NotebookData>
serializeNotebook(data: NotebookData, token: CancellationToken): Uint8Array | Thenable<Uint8Array>
OnEnterRule Propertiesaction: EnterAction
OnTypeFormattingEditProvider MethodsprovideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>
OpenDialogOptions PropertiesdefaultUri?: Uri
OutputChannel Properties Methods Parameter Description value: string Returns Description voidappendLine(value: string): void
Parameter Description value: string Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description value: string Returns Description voidshow(preserveFocus?: boolean): void
Parameter Description preserveFocus?: boolean Returns Description voidshow(column?: ViewColumn, preserveFocus?: boolean): void
Parameter Description column?: ViewColumn preserveFocus?: boolean Returns Description void OverviewRulerLane Enumeration Members ParameterInformation Constructorsnew ParameterInformation(label: string | [number, number], documentation?: string | MarkdownString): ParameterInformation
Propertiesdocumentation?: string | MarkdownString
label: string | [number, number]
Position Constructorsnew Position(line: number, character: number): Position
Parameter Description line: number character: number Returns Description Position Properties MethodscompareTo(other: Position): number
Parameter Description other: Position Returns Description numberisAfter(other: Position): boolean
Parameter Description other: Position Returns Description booleanisAfterOrEqual(other: Position): boolean
Parameter Description other: Position Returns Description booleanisBefore(other: Position): boolean
Parameter Description other: Position Returns Description booleanisBeforeOrEqual(other: Position): boolean
Parameter Description other: Position Returns Description booleanisEqual(other: Position): boolean
Parameter Description other: Position Returns Description booleantranslate(lineDelta?: number, characterDelta?: number): Position
Parameter Description lineDelta?: number characterDelta?: number Returns Description Positiontranslate(change: {characterDelta: number, lineDelta: number}): Position
Parameter Description change: {characterDelta: number, lineDelta: number} Returns Description Positionwith(line?: number, character?: number): Position
Parameter Description line?: number character?: number Returns Description Positionwith(change: {character: number, line: number}): Position
Parameter Description change: {character: number, line: number} Returns Description Position PreparedToolInvocation PropertiesconfirmationMessages?: LanguageModelToolConfirmationMessages
invocationMessage?: string | MarkdownString
ProcessExecution Constructorsnew ProcessExecution(process: string, options?: ProcessExecutionOptions): ProcessExecution
new ProcessExecution(process: string, args: string[], options?: ProcessExecutionOptions): ProcessExecution
Propertiesoptions?: ProcessExecutionOptions
ProcessExecutionOptions Properties Progress<T> Methods Parameter Description value: T Returns Description void ProgressLocation Enumeration Members ProgressOptions Propertieslocation: ProgressLocation | {viewId: string}
ProviderResult<T>ProviderResult: T | undefined | null | Thenable<T | undefined | null>
Pseudoterminal EventsonDidChangeName?: Event<string>
onDidClose?: Event<number | void>
onDidOverrideDimensions?: Event<TerminalDimensions>
onDidWrite: Event<string>
Methods Parameter Description Returns Description voidhandleInput(data: string): void
Parameter Description data: string Returns Description voidopen(initialDimensions: TerminalDimensions): void
setDimensions(dimensions: TerminalDimensions): void
QuickDiffProvider MethodsprovideOriginalResource(uri: Uri, token: CancellationToken): ProviderResult<Uri>
QuickInput EventsonDidHide: Event<void>
Properties Methods Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void QuickInputButton PropertiesiconPath: IconPath
QuickInputButtons StaticBack: QuickInputButton
QuickPick<T> EventsonDidAccept: Event<void>
onDidChangeActive: Event<readonly T[]>
onDidChangeSelection: Event<readonly T[]>
onDidChangeValue: Event<string>
onDidHide: Event<void>
onDidTriggerButton: Event<QuickInputButton>
onDidTriggerItemButton: Event<QuickPickItemButtonEvent<T>>
Propertiesbuttons: readonly QuickInputButton[]
Methods Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void QuickPickItem Propertiesbuttons?: readonly QuickInputButton[]
iconPath?: IconPath
kind?: QuickPickItemKind
QuickPickItemButtonEvent<T> Propertiesbutton: QuickInputButton
QuickPickItemKind Enumeration Members QuickPickOptions EventsonDidSelectItem(item: string | QuickPickItem): any
Parameter Description item: string | QuickPickItem Returns Description any Properties Range Constructorsnew Range(start: Position, end: Position): Range
new Range(startLine: number, startCharacter: number, endLine: number, endCharacter: number): Range
Parameter Description startLine: number startCharacter: number endLine: number endCharacter: number Returns Description Range Propertiesend: Position
start: Position
Methodscontains(positionOrRange: Range | Position): boolean
Parameter Description positionOrRange: Range | Position Returns Description booleanintersection(range: Range): Range
Parameter Description range: Range Returns Description RangeisEqual(other: Range): boolean
Parameter Description other: Range Returns Description boolean Parameter Description other: Range Returns Description Rangewith(start?: Position, end?: Position): Range
with(change: {end: Position, start: Position}): Range
ReferenceContext Properties ReferenceProvider MethodsprovideReferences(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>
RelativePattern Constructorsnew RelativePattern(base: string | Uri | WorkspaceFolder, pattern: string): RelativePattern
PropertiesbaseUri: Uri
RenameProvider MethodsprepareRename(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Range | {placeholder: string, range: Range}>
provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit>
RunOptions Properties SaveDialogOptions PropertiesdefaultUri?: Uri
SecretStorage EventsonDidChange: Event<SecretStorageChangeEvent>
Methodsdelete(key: string): Thenable<void>
Parameter Description key: string Returns Description Thenable<void>get(key: string): Thenable<string>
Parameter Description key: string Returns Description Thenable<string>store(key: string, value: string): Thenable<void>
Parameter Description key: string value: string Returns Description Thenable<void> SecretStorageChangeEvent Properties SelectedCompletionInfo Propertiesrange: Range
Selection Constructorsnew Selection(anchor: Position, active: Position): Selection
new Selection(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number): Selection
Parameter Description anchorLine: number anchorCharacter: number activeLine: number activeCharacter: number Returns Description Selection Propertiesactive: Position
anchor: Position
end: Position
start: Position
Methodscontains(positionOrRange: Range | Position): boolean
Parameter Description positionOrRange: Range | Position Returns Description booleanintersection(range: Range): Range
Parameter Description range: Range Returns Description RangeisEqual(other: Range): boolean
Parameter Description other: Range Returns Description boolean Parameter Description other: Range Returns Description Rangewith(start?: Position, end?: Position): Range
with(change: {end: Position, start: Position}): Range
SelectionRange Constructorsnew SelectionRange(range: Range, parent?: SelectionRange): SelectionRange
Propertiesparent?: SelectionRange
range: Range
SelectionRangeProvider MethodsprovideSelectionRanges(document: TextDocument, positions: readonly Position[], token: CancellationToken): ProviderResult<SelectionRange[]>
SemanticTokens Constructorsnew SemanticTokens(data: Uint32Array, resultId?: string): SemanticTokens
Parameter Description data: Uint32Array resultId?: string Returns Description SemanticTokens Properties SemanticTokensBuilder Constructorsnew SemanticTokensBuilder(legend?: SemanticTokensLegend): SemanticTokensBuilder
Methodsbuild(resultId?: string): SemanticTokens
Parameter Description resultId?: string Returns Description SemanticTokenspush(line: number, char: number, length: number, tokenType: number, tokenModifiers?: number): void
Parameter Description line: number char: number length: number tokenType: number tokenModifiers?: number Returns Description voidpush(range: Range, tokenType: string, tokenModifiers?: readonly string[]): void
Parameter Description range: Range tokenType: string tokenModifiers?: readonly string[] Returns Description void SemanticTokensEdit Constructorsnew SemanticTokensEdit(start: number, deleteCount: number, data?: Uint32Array): SemanticTokensEdit
Parameter Description start: number deleteCount: number data?: Uint32Array Returns Description SemanticTokensEdit Properties SemanticTokensEdits Constructorsnew SemanticTokensEdits(edits: SemanticTokensEdit[], resultId?: string): SemanticTokensEdits
Propertiesedits: SemanticTokensEdit[]
SemanticTokensLegend Constructorsnew SemanticTokensLegend(tokenTypes: string[], tokenModifiers?: string[]): SemanticTokensLegend
Parameter Description tokenTypes: string[] tokenModifiers?: string[] Returns Description SemanticTokensLegend Properties ShellExecution Constructorsnew ShellExecution(commandLine: string, options?: ShellExecutionOptions): ShellExecution
new ShellExecution(command: string | ShellQuotedString, args: Array<string | ShellQuotedString>, options?: ShellExecutionOptions): ShellExecution
Propertiesargs: Array<string | ShellQuotedString>
command: string | ShellQuotedString
options?: ShellExecutionOptions
ShellExecutionOptions PropertiesshellQuoting?: ShellQuotingOptions
ShellQuotedString Propertiesquoting: ShellQuoting
ShellQuoting Enumeration Members ShellQuotingOptions Propertiesescape?: string | {charsToEscape: string, escapeChar: string}
SignatureHelp Constructorsnew SignatureHelp(): SignatureHelp
Propertiessignatures: SignatureInformation[]
SignatureHelpContext PropertiesactiveSignatureHelp: SignatureHelp
triggerKind: SignatureHelpTriggerKind
SignatureHelpProvider MethodsprovideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelp>
SignatureHelpProviderMetadata PropertiesretriggerCharacters: readonly string[]
triggerCharacters: readonly string[]
SignatureHelpTriggerKind Enumeration Members SignatureInformation Constructorsnew SignatureInformation(label: string, documentation?: string | MarkdownString): SignatureInformation
Propertiesdocumentation?: string | MarkdownString
parameters: ParameterInformation[]
SnippetString Constructorsnew SnippetString(value?: string): SnippetString
Parameter Description value?: string Returns Description SnippetString Properties MethodsappendChoice(values: readonly string[], number?: number): SnippetString
Parameter Description values: readonly string[] number?: number Returns Description SnippetStringappendPlaceholder(value: string | (snippet: SnippetString) => any, number?: number): SnippetString
appendTabstop(number?: number): SnippetString
Parameter Description number?: number Returns Description SnippetStringappendText(string: string): SnippetString
Parameter Description string: string Returns Description SnippetStringappendVariable(name: string, defaultValue: string | (snippet: SnippetString) => any): SnippetString
SnippetTextEdit Staticinsert(position: Position, snippet: SnippetString): SnippetTextEdit
replace(range: Range, snippet: SnippetString): SnippetTextEdit
Constructorsnew SnippetTextEdit(range: Range, snippet: SnippetString): SnippetTextEdit
Propertiesrange: Range
snippet: SnippetString
SourceBreakpoint Constructorsnew SourceBreakpoint(location: Location, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string): SourceBreakpoint
Parameter Description location: Location enabled?: boolean condition?: string hitCondition?: string logMessage?: string Returns Description SourceBreakpoint Propertieslocation: Location
SourceControl PropertiesacceptInputCommand?: Command
inputBox: SourceControlInputBox
quickDiffProvider?: QuickDiffProvider
rootUri: Uri
statusBarCommands?: Command[]
MethodscreateResourceGroup(id: string, label: string): SourceControlResourceGroup
Parameter Description Returns Description void SourceControlInputBox Properties SourceControlResourceDecorations Propertiesdark?: SourceControlResourceThemableDecorations
iconPath?: string | Uri | ThemeIcon
light?: SourceControlResourceThemableDecorations
SourceControlResourceGroup PropertiesresourceStates: SourceControlResourceState[]
Methods Parameter Description Returns Description void SourceControlResourceState Propertiescommand?: Command
decorations?: SourceControlResourceDecorations
resourceUri: Uri
SourceControlResourceThemableDecorations PropertiesiconPath?: string | Uri | ThemeIcon
StatementCoverage Constructorsnew StatementCoverage(executed: number | boolean, location: Range | Position, branches?: BranchCoverage[]): StatementCoverage
Propertiesbranches: BranchCoverage[]
StatusBarAlignment Enumeration Members StatusBarItem PropertiesaccessibilityInformation: AccessibilityInformation
alignment: StatusBarAlignment
backgroundColor: ThemeColor
color: string | ThemeColor
command: string | Command
tooltip: string | MarkdownString
Methods Parameter Description Returns Description void Parameter Description Returns Description void Parameter Description Returns Description void SymbolInformation Constructorsnew SymbolInformation(name: string, kind: SymbolKind, containerName: string, location: Location): SymbolInformation
new SymbolInformation(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string): SymbolInformation
Propertieskind: SymbolKind
location: Location
tags?: readonly SymbolTag[]
SymbolKind Enumeration Members SymbolTag Enumeration Members SyntaxTokenType Enumeration Members Tab Propertiesgroup: TabGroup
TabChangeEvent Propertieschanged: readonly Tab[]
closed: readonly Tab[]
opened: readonly Tab[]
TabGroup PropertiesactiveTab: Tab
tabs: readonly Tab[]
viewColumn: ViewColumn
TabGroupChangeEvent Propertieschanged: readonly TabGroup[]
closed: readonly TabGroup[]
opened: readonly TabGroup[]
TabGroups EventsonDidChangeTabGroups: Event<TabGroupChangeEvent>
onDidChangeTabs: Event<TabChangeEvent>
PropertiesactiveTabGroup: TabGroup
all: readonly TabGroup[]
Methodsclose(tab: Tab | readonly Tab[], preserveFocus?: boolean): Thenable<boolean>
Parameter Description tab: Tab | readonly Tab[] preserveFocus?: boolean Returns Description Thenable<boolean>close(tabGroup: TabGroup | readonly TabGroup[], preserveFocus?: boolean): Thenable<boolean>
Parameter Description tabGroup: TabGroup | readonly TabGroup[] preserveFocus?: boolean Returns Description Thenable<boolean> TabInputCustom Constructorsnew TabInputCustom(uri: Uri, viewType: string): TabInputCustom
Propertiesuri: Uri
TabInputNotebook Constructorsnew TabInputNotebook(uri: Uri, notebookType: string): TabInputNotebook
Propertiesuri: Uri
TabInputNotebookDiff Constructorsnew TabInputNotebookDiff(original: Uri, modified: Uri, notebookType: string): TabInputNotebookDiff
Propertiesmodified: Uri
original: Uri
TabInputTerminal Constructorsnew TabInputTerminal(): TabInputTerminal
TabInputText Constructorsnew TabInputText(uri: Uri): TabInputText
Propertiesuri: Uri
TabInputTextDiff Constructorsnew TabInputTextDiff(original: Uri, modified: Uri): TabInputTextDiff
Propertiesmodified: Uri
original: Uri
TabInputWebview Constructorsnew TabInputWebview(viewType: string): TabInputWebview
Properties Task Constructorsnew Task(taskDefinition: TaskDefinition, scope: WorkspaceFolder | Global | Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution | CustomExecution, problemMatchers?: string | string[]): Task
new Task(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]): Task
Propertiesdefinition: TaskDefinition
execution?: ProcessExecution | ShellExecution | CustomExecution
group?: TaskGroup
presentationOptions: TaskPresentationOptions
runOptions: RunOptions
scope: WorkspaceFolder | Global | Workspace
TaskDefinition Properties TaskEndEvent Propertiesexecution: TaskExecution
TaskExecution Propertiestask: Task
Methods Parameter Description Returns Description void TaskFilter Properties TaskGroup StaticBuild: TaskGroup
Clean: TaskGroup
Rebuild: TaskGroup
Test: TaskGroup
Constructorsnew TaskGroup(id: string, label: string): TaskGroup
Parameter Description id: string label: string Returns Description TaskGroup Properties TaskPanelKind Enumeration Members TaskPresentationOptions Propertiespanel?: TaskPanelKind
reveal?: TaskRevealKind
TaskProcessEndEvent Propertiesexecution: TaskExecution
TaskProcessStartEvent Propertiesexecution: TaskExecution
TaskProvider<T> MethodsprovideTasks(token: CancellationToken): ProviderResult<T[]>
resolveTask(task: T, token: CancellationToken): ProviderResult<T>
TaskRevealKind Enumeration Members TaskScope Enumeration Members TaskStartEvent Propertiesexecution: TaskExecution
TelemetryLogger EventsonDidChangeEnableStates: Event<TelemetryLogger>
Properties Methods Parameter Description Returns Description voidlogError(eventName: string, data?: Record<string, any>): void
Parameter Description eventName: string data?: Record<string, any> Returns Description voidlogError(error: Error, data?: Record<string, any>): void
Parameter Description error: Error data?: Record<string, any> Returns Description voidlogUsage(eventName: string, data?: Record<string, any>): void
Parameter Description eventName: string data?: Record<string, any> Returns Description void TelemetryLoggerOptions PropertiesadditionalCommonProperties?: Record<string, any>
ignoreBuiltInCommonProperties?: boolean
ignoreUnhandledErrors?: boolean
TelemetrySender Methodsflush(): void | Thenable<void>
Parameter Description Returns Description void | Thenable<void>sendErrorData(error: Error, data?: Record<string, any>): void
Parameter Description error: Error data?: Record<string, any> Returns Description voidsendEventData(eventName: string, data?: Record<string, any>): void
Parameter Description eventName: string data?: Record<string, any> Returns Description void TelemetryTrustedValue<T> Constructorsnew TelemetryTrustedValue<T>(value: T): TelemetryTrustedValue<T>
Properties Terminal PropertiescreationOptions: Readonly<TerminalOptions | ExtensionTerminalOptions>
exitStatus: TerminalExitStatus
shellIntegration: TerminalShellIntegration
state: TerminalState
Methods Parameter Description Returns Description void Parameter Description Returns Description voidsendText(text: string, shouldExecute?: boolean): void
Parameter Description text: string shouldExecute?: boolean Returns Description voidshow(preserveFocus?: boolean): void
Parameter Description preserveFocus?: boolean Returns Description void TerminalDimensions Properties TerminalEditorLocationOptions PropertiesviewColumn: ViewColumn
TerminalExitReason Enumeration Members TerminalExitStatus Propertiesreason: TerminalExitReason
TerminalLink Constructorsnew TerminalLink(startIndex: number, length: number, tooltip?: string): TerminalLink
Parameter Description startIndex: number length: number tooltip?: string Returns Description TerminalLink Properties TerminalLinkContext Propertiesterminal: Terminal
TerminalLinkProvider<T> MethodshandleTerminalLink(link: T): ProviderResult<void>
Parameter Description link: T Returns Description ProviderResult<void>provideTerminalLinks(context: TerminalLinkContext, token: CancellationToken): ProviderResult<T[]>
TerminalLocation Enumeration Members TerminalOptions Propertiescolor?: ThemeColor
cwd?: string | Uri
iconPath?: IconPath
location?: TerminalEditorLocationOptions | TerminalSplitLocationOptions | TerminalLocation
TerminalProfile Constructorsnew TerminalProfile(options: TerminalOptions | ExtensionTerminalOptions): TerminalProfile
Propertiesoptions: TerminalOptions | ExtensionTerminalOptions
TerminalProfileProvider MethodsprovideTerminalProfile(token: CancellationToken): ProviderResult<TerminalProfile>
TerminalShellExecution PropertiescommandLine: TerminalShellExecutionCommandLine
cwd: Uri
Methods Parameter Description Returns Description AsyncIterable<string> TerminalShellExecutionCommandLine Propertiesconfidence: TerminalShellExecutionCommandLineConfidence
TerminalShellExecutionCommandLineConfidence Enumeration Members TerminalShellExecutionEndEvent Propertiesexecution: TerminalShellExecution
shellIntegration: TerminalShellIntegration
terminal: Terminal
TerminalShellExecutionStartEvent Propertiesexecution: TerminalShellExecution
shellIntegration: TerminalShellIntegration
terminal: Terminal
TerminalShellIntegration Propertiescwd: Uri
MethodsexecuteCommand(commandLine: string): TerminalShellExecution
executeCommand(executable: string, args: string[]): TerminalShellExecution
TerminalShellIntegrationChangeEvent PropertiesshellIntegration: TerminalShellIntegration
terminal: Terminal
TerminalSplitLocationOptions PropertiesparentTerminal: Terminal
TerminalState Properties TestController Propertiesitems: TestItemCollection
refreshHandler: (token: CancellationToken) => void | Thenable<void>
Parameter Description token: CancellationToken Returns Description void | Thenable<void>resolveHandler?: (item: TestItem) => void | Thenable<void>
Parameter Description item: TestItem Returns Description void | Thenable<void> MethodscreateRunProfile(label: string, kind: TestRunProfileKind, runHandler: (request: TestRunRequest, token: CancellationToken) => void | Thenable<void>, isDefault?: boolean, tag?: TestTag, supportsContinuousRun?: boolean): TestRunProfile
createTestItem(id: string, label: string, uri?: Uri): TestItem
Parameter Description id: string label: string uri?: Uri Returns Description TestItemcreateTestRun(request: TestRunRequest, name?: string, persist?: boolean): TestRun
Parameter Description request: TestRunRequest name?: string persist?: boolean Returns Description TestRun Parameter Description Returns Description voidinvalidateTestResults(items?: TestItem | readonly TestItem[]): void
Parameter Description items?: TestItem | readonly TestItem[] Returns Description void TestCoverageCount Constructorsnew TestCoverageCount(covered: number, total: number): TestCoverageCount
Parameter Description covered: number total: number Returns Description TestCoverageCount Properties TestItem Propertieschildren: TestItemCollection
error: string | MarkdownString
parent: TestItem
range: Range
tags: readonly TestTag[]
uri: Uri
TestItemCollection Properties Methodsadd(item: TestItem): void
Parameter Description item: TestItem Returns Description void Parameter Description itemId: string Returns Description voidforEach(callback: (item: TestItem, collection: TestItemCollection) => unknown, thisArg?: any): void
Parameter Description callback: (item: TestItem, collection: TestItemCollection) => unknown thisArg?: any Returns Description voidget(itemId: string): TestItem
Parameter Description itemId: string Returns Description TestItemreplace(items: readonly TestItem[]): void
Parameter Description items: readonly TestItem[] Returns Description void TestMessage Staticdiff(message: string | MarkdownString, expected: string, actual: string): TestMessage
Constructorsnew TestMessage(message: string | MarkdownString): TestMessage
Propertieslocation?: Location
message: string | MarkdownString
stackTrace?: TestMessageStackFrame[]
TestMessageStackFrame Constructorsnew TestMessageStackFrame(label: string, uri?: Uri, position?: Position): TestMessageStackFrame
Propertiesposition?: Position
uri?: Uri
TestRun EventsonDidDispose: Event<void>
Propertiestoken: CancellationToken
MethodsaddCoverage(fileCoverage: FileCoverage): void
Parameter Description fileCoverage: FileCoverage Returns Description voidappendOutput(output: string, location?: Location, test?: TestItem): void
Parameter Description output: string location?: Location test?: TestItem Returns Description void Parameter Description Returns Description voidenqueued(test: TestItem): void
Parameter Description test: TestItem Returns Description voiderrored(test: TestItem, message: TestMessage | readonly TestMessage[], duration?: number): void
failed(test: TestItem, message: TestMessage | readonly TestMessage[], duration?: number): void
passed(test: TestItem, duration?: number): void
Parameter Description test: TestItem duration?: number Returns Description voidskipped(test: TestItem): void
Parameter Description test: TestItem Returns Description voidstarted(test: TestItem): void
Parameter Description test: TestItem Returns Description void TestRunProfile EventsonDidChangeDefault: Event<boolean>
Properties Parameter Description Returns Description voidkind: TestRunProfileKind
loadDetailedCoverage?: (testRun: TestRun, fileCoverage: FileCoverage, token: CancellationToken) => Thenable<FileCoverageDetail[]>
loadDetailedCoverageForTest?: (testRun: TestRun, fileCoverage: FileCoverage, fromTestItem: TestItem, token: CancellationToken) => Thenable<FileCoverageDetail[]>
runHandler: (request: TestRunRequest, token: CancellationToken) => void | Thenable<void>
supportsContinuousRun: boolean
tag: TestTag
Methods Parameter Description Returns Description void TestRunProfileKind Enumeration Members TestRunRequest Constructorsnew TestRunRequest(include?: readonly TestItem[], exclude?: readonly TestItem[], profile?: TestRunProfile, continuous?: boolean, preserveFocus?: boolean): TestRunRequest
Propertiesexclude: readonly TestItem[]
include: readonly TestItem[]
profile: TestRunProfile
TestTag Constructorsnew TestTag(id: string): TestTag
Parameter Description id: string Returns Description TestTag Properties TextDocument Propertieseol: EndOfLine
uri: Uri
MethodsgetText(range?: Range): string
Parameter Description range?: Range Returns Description stringgetWordRangeAtPosition(position: Position, regex?: RegExp): Range
Parameter Description position: Position regex?: RegExp Returns Description RangelineAt(line: number): TextLine
Parameter Description line: number Returns Description TextLinelineAt(position: Position): TextLine
offsetAt(position: Position): number
Parameter Description position: Position Returns Description numberpositionAt(offset: number): Position
Parameter Description offset: number Returns Description Position Parameter Description Returns Description Thenable<boolean>validatePosition(position: Position): Position
validateRange(range: Range): Range
Parameter Description range: Range Returns Description Range TextDocumentChangeEvent PropertiescontentChanges: readonly TextDocumentContentChangeEvent[]
document: TextDocument
reason: TextDocumentChangeReason
TextDocumentChangeReason Enumeration Members TextDocumentContentChangeEvent Propertiesrange: Range
TextDocumentContentProvider Events MethodsprovideTextDocumentContent(uri: Uri, token: CancellationToken): ProviderResult<string>
TextDocumentSaveReason Enumeration Members TextDocumentShowOptions Propertiesselection?: Range
viewColumn?: ViewColumn
TextDocumentWillSaveEvent Propertiesdocument: TextDocument
reason: TextDocumentSaveReason
MethodswaitUntil(thenable: Thenable<readonly TextEdit[]>): void
Parameter Description thenable: Thenable<readonly TextEdit[]> Returns Description voidwaitUntil(thenable: Thenable<any>): void
Parameter Description thenable: Thenable<any> Returns Description void TextEdit Staticdelete(range: Range): TextEdit
insert(position: Position, newText: string): TextEdit
Parameter Description position: Position newText: string Returns Description TextEditreplace(range: Range, newText: string): TextEdit
Parameter Description range: Range newText: string Returns Description TextEditsetEndOfLine(eol: EndOfLine): TextEdit
Constructorsnew TextEdit(range: Range, newText: string): TextEdit
Parameter Description range: Range newText: string Returns Description TextEdit PropertiesnewEol?: EndOfLine
range: Range
TextEditor Propertiesdocument: TextDocument
options: TextEditorOptions
selection: Selection
selections: readonly Selection[]
viewColumn: ViewColumn
visibleRanges: readonly Range[]
Methodsedit(callback: (editBuilder: TextEditorEdit) => void, options?: {undoStopAfter: boolean, undoStopBefore: boolean}): Thenable<boolean>
Parameter Description callback: (editBuilder: TextEditorEdit) => void options?: {undoStopAfter: boolean, undoStopBefore: boolean} Returns Description Thenable<boolean> Parameter Description Returns Description voidinsertSnippet(snippet: SnippetString, location?: Range | Position | readonly Range[] | readonly Position[], options?: {keepWhitespace: boolean, undoStopAfter: boolean, undoStopBefore: boolean}): Thenable<boolean>
Parameter Description snippet: SnippetString location?: Range | Position | readonly Range[] | readonly Position[] options?: {keepWhitespace: boolean, undoStopAfter: boolean, undoStopBefore: boolean} Returns Description Thenable<boolean>revealRange(range: Range, revealType?: TextEditorRevealType): void
setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: readonly Range[] | readonly DecorationOptions[]): void
show(column?: ViewColumn): void
Parameter Description column?: ViewColumn Returns Description void TextEditorCursorStyle Enumeration Members TextEditorDecorationType Properties Methods Parameter Description Returns Description void TextEditorEdit Methodsdelete(location: Range | Selection): void
Parameter Description location: Range | Selection Returns Description voidinsert(location: Position, value: string): void
Parameter Description location: Position value: string Returns Description voidreplace(location: Range | Position | Selection, value: string): void
setEndOfLine(endOfLine: EndOfLine): void
Parameter Description endOfLine: EndOfLine Returns Description void Enumeration Members TextEditorOptions PropertiescursorStyle?: TextEditorCursorStyle
insertSpaces?: string | boolean
lineNumbers?: TextEditorLineNumbersStyle
TextEditorOptionsChangeEvent Propertiesoptions: TextEditorOptions
textEditor: TextEditor
TextEditorRevealType Enumeration Members TextEditorSelectionChangeEvent Propertieskind: TextEditorSelectionChangeKind
selections: readonly Selection[]
textEditor: TextEditor
TextEditorSelectionChangeKind Enumeration Members TextEditorViewColumnChangeEvent PropertiestextEditor: TextEditor
viewColumn: ViewColumn
TextEditorVisibleRangesChangeEvent PropertiestextEditor: TextEditor
visibleRanges: readonly Range[]
TextLine PropertiesfirstNonWhitespaceCharacterIndex: number
range: Range
rangeIncludingLineBreak: Range
ThemableDecorationAttachmentRenderOptions PropertiesbackgroundColor?: string | ThemeColor
borderColor?: string | ThemeColor
color?: string | ThemeColor
contentIconPath?: string | Uri
ThemableDecorationInstanceRenderOptions Propertiesafter?: ThemableDecorationAttachmentRenderOptions
before?: ThemableDecorationAttachmentRenderOptions
ThemableDecorationRenderOptions Propertiesafter?: ThemableDecorationAttachmentRenderOptions
backgroundColor?: string | ThemeColor
before?: ThemableDecorationAttachmentRenderOptions
borderColor?: string | ThemeColor
color?: string | ThemeColor
gutterIconPath?: string | Uri
outlineColor?: string | ThemeColor
overviewRulerColor?: string | ThemeColor
ThemeColor Constructorsnew ThemeColor(id: string): ThemeColor
Parameter Description id: string Returns Description ThemeColor Properties ThemeIcon StaticFile: ThemeIcon
Folder: ThemeIcon
Constructorsnew ThemeIcon(id: string, color?: ThemeColor): ThemeIcon
Propertiescolor?: ThemeColor
TreeCheckboxChangeEvent<T> Propertiesitems: ReadonlyArray<[T, TreeItemCheckboxState]>
TreeDataProvider<T> EventsonDidChangeTreeData?: Event<void | T | T[]>
MethodsgetChildren(element?: T): ProviderResult<T[]>
Parameter Description element?: T Returns Description ProviderResult<T[]>getParent(element: T): ProviderResult<T>
Parameter Description element: T Returns Description ProviderResult<T>getTreeItem(element: T): TreeItem | Thenable<TreeItem>
Parameter Description element: T Returns Description TreeItem | Thenable<TreeItem>resolveTreeItem(item: TreeItem, element: T, token: CancellationToken): ProviderResult<TreeItem>
TreeDragAndDropController<T> PropertiesdragMimeTypes: readonly string[]
dropMimeTypes: readonly string[]
MethodshandleDrag(source: readonly T[], dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>
handleDrop(target: T, dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>
TreeItem Constructorsnew TreeItem(label: string | TreeItemLabel, collapsibleState?: TreeItemCollapsibleState): TreeItem
new TreeItem(resourceUri: Uri, collapsibleState?: TreeItemCollapsibleState): TreeItem
PropertiesaccessibilityInformation?: AccessibilityInformation
checkboxState?: TreeItemCheckboxState | {accessibilityInformation: AccessibilityInformation, state: TreeItemCheckboxState, tooltip: string}
collapsibleState?: TreeItemCollapsibleState
command?: Command
description?: string | boolean
iconPath?: string | IconPath
label?: string | TreeItemLabel
resourceUri?: Uri
tooltip?: string | MarkdownString
TreeItemCheckboxState Enumeration Members TreeItemCollapsibleState Enumeration Members TreeItemLabel Propertieshighlights?: Array<[number, number]>
TreeView<T> EventsonDidChangeCheckboxState: Event<TreeCheckboxChangeEvent<T>>
onDidChangeSelection: Event<TreeViewSelectionChangeEvent<T>>
onDidChangeVisibility: Event<TreeViewVisibilityChangeEvent>
onDidCollapseElement: Event<TreeViewExpansionEvent<T>>
onDidExpandElement: Event<TreeViewExpansionEvent<T>>
Propertiesbadge?: ViewBadge
Methods Parameter Description Returns Description anyreveal(element: T, options?: {expand: number | boolean, focus: boolean, select: boolean}): Thenable<void>
Parameter Description element: T options?: {expand: number | boolean, focus: boolean, select: boolean} Returns Description Thenable<void> TreeViewExpansionEvent<T> Properties TreeViewOptions<T> PropertiesdragAndDropController?: TreeDragAndDropController<T>
manageCheckboxStateManually?: boolean
treeDataProvider: TreeDataProvider<T>
TreeViewSelectionChangeEvent<T> Properties TreeViewVisibilityChangeEvent Properties TypeDefinitionProvider MethodsprovideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>
TypeHierarchyItem Constructorsnew TypeHierarchyItem(kind: SymbolKind, name: string, detail: string, uri: Uri, range: Range, selectionRange: Range): TypeHierarchyItem
Propertieskind: SymbolKind
range: Range
selectionRange: Range
tags?: readonly SymbolTag[]
uri: Uri
TypeHierarchyProvider MethodsprepareTypeHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<TypeHierarchyItem | TypeHierarchyItem[]>
provideTypeHierarchySubtypes(item: TypeHierarchyItem, token: CancellationToken): ProviderResult<TypeHierarchyItem[]>
provideTypeHierarchySupertypes(item: TypeHierarchyItem, token: CancellationToken): ProviderResult<TypeHierarchyItem[]>
UIKind Enumeration Members Uri Staticfile(path: string): Uri
Parameter Description path: string Returns Description Urifrom(components: {authority: string, fragment: string, path: string, query: string, scheme: string}): Uri
Parameter Description components: {authority: string, fragment: string, path: string, query: string, scheme: string} Returns Description UrijoinPath(base: Uri, ...pathSegments: string[]): Uri
Parameter Description base: Uri ...pathSegments: string[] Returns Description Uriparse(value: string, strict?: boolean): Uri
Parameter Description value: string strict?: boolean Returns Description Uri Constructorsnew Uri(scheme: string, authority: string, path: string, query: string, fragment: string): Uri
Parameter Description scheme: string authority: string path: string query: string fragment: string Returns Description Uri Properties Methods Parameter Description Returns Description anytoString(skipEncoding?: boolean): string
Parameter Description skipEncoding?: boolean Returns Description stringwith(change: {authority: string, fragment: string, path: string, query: string, scheme: string}): Uri
Parameter Description change: {authority: string, fragment: string, path: string, query: string, scheme: string} Returns Description Uri UriHandler MethodshandleUri(uri: Uri): ProviderResult<void>
ViewBadge Properties ViewColumn Enumeration Members Webview EventsonDidReceiveMessage: Event<any>
Propertiesoptions: WebviewOptions
MethodsasWebviewUri(localResource: Uri): Uri
Parameter Description localResource: Uri Returns Description UripostMessage(message: any): Thenable<boolean>
Parameter Description message: any Returns Description Thenable<boolean> WebviewOptions PropertiesenableCommandUris?: boolean | readonly string[]
localResourceRoots?: readonly Uri[]
portMapping?: readonly WebviewPortMapping[]
WebviewPanel EventsonDidChangeViewState: Event<WebviewPanelOnDidChangeViewStateEvent>
onDidDispose: Event<void>
PropertiesiconPath?: Uri | {dark: Uri, light: Uri}
options: WebviewPanelOptions
viewColumn: ViewColumn
webview: Webview
Methods Parameter Description Returns Description anyreveal(viewColumn?: ViewColumn, preserveFocus?: boolean): void
Parameter Description viewColumn?: ViewColumn preserveFocus?: boolean Returns Description void WebviewPanelOnDidChangeViewStateEvent PropertieswebviewPanel: WebviewPanel
WebviewPanelOptions PropertiesretainContextWhenHidden?: boolean
WebviewPanelSerializer<T> MethodsdeserializeWebviewPanel(webviewPanel: WebviewPanel, state: T): Thenable<void>
Parameter Description webviewPanel: WebviewPanel state: T Returns Description Thenable<void> WebviewPortMapping Properties WebviewView EventsonDidChangeVisibility: Event<void>
onDidDispose: Event<void>
Propertiesbadge?: ViewBadge
webview: Webview
Methodsshow(preserveFocus?: boolean): void
Parameter Description preserveFocus?: boolean Returns Description void WebviewViewProvider MethodsresolveWebviewView(webviewView: WebviewView, context: WebviewViewResolveContext<unknown>, token: CancellationToken): void | Thenable<void>
WebviewViewResolveContext<T> Properties WindowState Properties WorkspaceConfiguration Methods Parameter Description section: string Returns Description Tget<T>(section: string, defaultValue: T): T
Parameter Description section: string defaultValue: T Returns Description T Parameter Description section: string Returns Description booleaninspect<T>(section: string): {defaultLanguageValue: T, defaultValue: T, globalLanguageValue: T, globalValue: T, key: string, languageIds: string[], workspaceFolderLanguageValue: T, workspaceFolderValue: T, workspaceLanguageValue: T, workspaceValue: T}
Parameter Description section: string Returns Description {defaultLanguageValue: T, defaultValue: T, globalLanguageValue: T, globalValue: T, key: string, languageIds: string[], workspaceFolderLanguageValue: T, workspaceFolderValue: T, workspaceLanguageValue: T, workspaceValue: T}update(section: string, value: any, configurationTarget?: boolean | ConfigurationTarget, overrideInLanguage?: boolean): Thenable<void>
Parameter Description section: string value: any configurationTarget?: boolean | ConfigurationTarget overrideInLanguage?: boolean Returns Description Thenable<void> WorkspaceEdit Constructorsnew WorkspaceEdit(): WorkspaceEdit
Properties MethodscreateFile(uri: Uri, options?: {contents: Uint8Array | DataTransferFile, ignoreIfExists: boolean, overwrite: boolean}, metadata?: WorkspaceEditEntryMetadata): void
delete(uri: Uri, range: Range, metadata?: WorkspaceEditEntryMetadata): void
deleteFile(uri: Uri, options?: {ignoreIfNotExists: boolean, recursive: boolean}, metadata?: WorkspaceEditEntryMetadata): void
Parameter Description uri: Uri options?: {ignoreIfNotExists: boolean, recursive: boolean} metadata?: WorkspaceEditEntryMetadata Returns Description voidentries(): Array<[Uri, TextEdit[]]>
Parameter Description Returns Description Array<[Uri, TextEdit[]]> Parameter Description uri: Uri Returns Description TextEdit[]has(uri: Uri): boolean
Parameter Description uri: Uri Returns Description booleaninsert(uri: Uri, position: Position, newText: string, metadata?: WorkspaceEditEntryMetadata): void
renameFile(oldUri: Uri, newUri: Uri, options?: {ignoreIfExists: boolean, overwrite: boolean}, metadata?: WorkspaceEditEntryMetadata): void
Parameter Description oldUri: Uri newUri: Uri options?: {ignoreIfExists: boolean, overwrite: boolean} metadata?: WorkspaceEditEntryMetadata Returns Description voidreplace(uri: Uri, range: Range, newText: string, metadata?: WorkspaceEditEntryMetadata): void
set(uri: Uri, edits: ReadonlyArray<TextEdit | SnippetTextEdit>): void
set(uri: Uri, edits: ReadonlyArray<[TextEdit | SnippetTextEdit, WorkspaceEditEntryMetadata]>): void
set(uri: Uri, edits: readonly NotebookEdit[]): void
Parameter Description uri: Uri edits: readonly NotebookEdit[] Returns Description voidset(uri: Uri, edits: ReadonlyArray<[NotebookEdit, WorkspaceEditEntryMetadata]>): void
WorkspaceEditEntryMetadata PropertiesiconPath?: IconPath
WorkspaceEditMetadata Properties WorkspaceFolder Propertiesuri: Uri
WorkspaceFolderPickOptions Properties WorkspaceFoldersChangeEvent Propertiesadded: readonly WorkspaceFolder[]
removed: readonly WorkspaceFolder[]
WorkspaceSymbolProvider<T> MethodsprovideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<T[]>
resolveWorkspaceSymbol(symbol: T, token: CancellationToken): ProviderResult<T>
API PatternsThese are some of the common patterns we use in the VS Code API.
PromisesThe VS Code API represents asynchronous operations with promises. From extensions, any type of promise can be returned, like ES6, WinJS, A+, etc.
Being independent of a specific promise library is expressed in the API by the Thenable-type. Thenable represents the common denominator which is the then method.
In most cases the use of promises is optional and when VS Code calls into an extension, it can handle the result type as well as a Thenable of the result type. When the use of a promise is optional, the API indicates this by returning or-types.
provideNumber(): number | Thenable<number>
Often operations are started on volatile state which changes before operations can finish. For instance, computing IntelliSense starts and the user continues to type making the result of that operation obsolete.
APIs that are exposed to such behavior will get passed a CancellationToken on which you can check for cancellation (isCancellationRequested) or get notified when cancellation occurs (onCancellationRequested). The cancellation token is usually the last parameter of a function call and optional.
The VS Code API uses the dispose pattern for resources that are obtained from VS Code. This applies to event listening, commands, interacting with the UI, and various language contributions.
For instance, the setStatusBarMessage(value: string) function returns a Disposable which upon calling dispose removes the message again.
Events in the VS Code API are exposed as functions which you call with a listener-function to subscribe. Calls to subscribe return a Disposable which removes the event listener upon dispose.
var listener = function(event) {
console.log('It happened', event);
};
// start listening
var subscription = fsWatcher.onDidDelete(listener);
// do more stuff
subscription.dispose(); // stop listening
Names of events follow the on[Will|Did]VerbNoun? pattern. The name signals if the event is going to happen (onWill) or already happened (onDid), what happened (verb), and the context (noun) unless obvious from the context.
An example from the VS Code API is window.onDidChangeActiveTextEditor which is an event fired when the active text editor (noun) has been (onDid) changed (verb).
The VS Code API uses the undefined and null TypeScript types where appropriate to support strict null checking.
08/07/2025
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4