kotlin-typescript/typescript/LanguageService

LanguageService

sealed external interface LanguageService(source)

Properties

abstract val toLineColumnOffset: (fileName: String, position: Double) -> LineAndCharacter?

Functions

abstract fun applyCodeActionCommand(action: ReadonlyArray<CodeActionCommand>, formatSettings: FormatCodeSettings = definedExternally): Promise<ReadonlyArray<ApplyCodeActionCommandResult>>

abstract fun applyCodeActionCommand(fileName: String, action: ReadonlyArray<CodeActionCommand>): Promise<ReadonlyArray<ApplyCodeActionCommandResult>>

abstract fun applyCodeActionCommand(fileName: String, action: CodeActionCommand): Promise<ApplyCodeActionCommandResult>

abstract fun applyCodeActionCommand(action: CodeActionCommand, formatSettings: FormatCodeSettings = definedExternally): Promise<ApplyCodeActionCommandResult>

cleanupSemanticCache

abstract fun cleanupSemanticCache()

This is used as a part of restarting the language service.

commentSelection

abstract fun commentSelection(fileName: String, textRange: TextRange): ReadonlyArray<TextChange>

dispose

abstract fun dispose()

findReferences

abstract fun findReferences(fileName: String, position: Double): ReadonlyArray<ReferencedSymbol>?

findRenameLocations

abstract fun findRenameLocations(fileName: String, position: Double, findInStrings: Boolean, findInComments: Boolean, providePrefixAndSuffixTextForRename: Boolean = definedExternally): ReadonlyArray<RenameLocation>?

abstract fun findRenameLocations(fileName: String, position: Double, findInStrings: Boolean, findInComments: Boolean, preferences: UserPreferences): ReadonlyArray<RenameLocation>?

getApplicableRefactors

abstract fun getApplicableRefactors(fileName: String, positionOrRange: Double, preferences: UserPreferences?, triggerReason: RefactorTriggerReason = definedExternally, kind: String = definedExternally, includeInteractiveActions: Boolean = definedExternally): ReadonlyArray<ApplicableRefactorInfo>

abstract fun getApplicableRefactors(fileName: String, positionOrRange: TextRange, preferences: UserPreferences?, triggerReason: RefactorTriggerReason = definedExternally, kind: String = definedExternally, includeInteractiveActions: Boolean = definedExternally): ReadonlyArray<ApplicableRefactorInfo>

getBraceMatchingAtPosition

abstract fun getBraceMatchingAtPosition(fileName: String, position: Double): ReadonlyArray<TextSpan>

getBreakpointStatementAtPosition

abstract fun getBreakpointStatementAtPosition(fileName: String, position: Double): TextSpan?

getCodeFixesAtPosition

abstract fun getCodeFixesAtPosition(fileName: String, start: Double, end: Double, errorCodes: ReadonlyArray<Double>, formatOptions: FormatCodeSettings, preferences: UserPreferences): ReadonlyArray<CodeFixAction>

getCombinedCodeFix

abstract fun getCombinedCodeFix(scope: CombinedCodeFixScope, fixId: Any, formatOptions: FormatCodeSettings, preferences: UserPreferences): CombinedCodeActions

getCompilerOptionsDiagnostics

abstract fun getCompilerOptionsDiagnostics(): ReadonlyArray<Diagnostic>

Gets global diagnostics related to the program configuration and compiler options.

getCompletionEntryDetails

abstract fun getCompletionEntryDetails(fileName: String, position: Double, entryName: String, formatOptions: FormatCodeOptions?, source: String?, preferences: UserPreferences?, data: CompletionEntryData?): CompletionEntryDetails?

abstract fun getCompletionEntryDetails(fileName: String, position: Double, entryName: String, formatOptions: FormatCodeSettings?, source: String?, preferences: UserPreferences?, data: CompletionEntryData?): CompletionEntryDetails?

Gets the extended details for a completion entry retrieved from getCompletionsAtPosition.

getCompletionEntrySymbol

abstract fun getCompletionEntrySymbol(fileName: String, position: Double, name: String, source: String?): Symbol?

getCompletionsAtPosition

abstract fun getCompletionsAtPosition(fileName: String, position: Double, options: GetCompletionsAtPositionOptions?, formattingSettings: FormatCodeSettings = definedExternally): WithMetadata<CompletionInfo>?

Gets completion entries at a particular position in a file.

getDefinitionAndBoundSpan

abstract fun getDefinitionAndBoundSpan(fileName: String, position: Double): DefinitionInfoAndBoundSpan?

getDefinitionAtPosition

abstract fun getDefinitionAtPosition(fileName: String, position: Double): ReadonlyArray<DefinitionInfo>?

getDocCommentTemplateAtPosition

abstract fun getDocCommentTemplateAtPosition(fileName: String, position: Double, options: DocCommentTemplateOptions = definedExternally, formatOptions: FormatCodeSettings = definedExternally): TextInsertion?

getDocumentHighlights

abstract fun getDocumentHighlights(fileName: String, position: Double, filesToSearch: ReadonlyArray<String>): ReadonlyArray<DocumentHighlights>?

getEditsForFileRename

abstract fun getEditsForFileRename(oldFilePath: String, newFilePath: String, formatOptions: FormatCodeSettings, preferences: UserPreferences?): ReadonlyArray<FileTextChanges>

getEditsForRefactor

abstract fun getEditsForRefactor(fileName: String, formatOptions: FormatCodeSettings, positionOrRange: Double, refactorName: String, actionName: String, preferences: UserPreferences?, interactiveRefactorArguments: InteractiveRefactorArguments = definedExternally): RefactorEditInfo?

abstract fun getEditsForRefactor(fileName: String, formatOptions: FormatCodeSettings, positionOrRange: TextRange, refactorName: String, actionName: String, preferences: UserPreferences?, interactiveRefactorArguments: InteractiveRefactorArguments = definedExternally): RefactorEditInfo?

getEmitOutput

abstract fun getEmitOutput(fileName: String, emitOnlyDtsFiles: Boolean = definedExternally, forceDtsEmit: Boolean = definedExternally): EmitOutput

getEncodedSemanticClassifications

abstract fun getEncodedSemanticClassifications(fileName: String, span: TextSpan, format: SemanticClassificationFormat = definedExternally): Classifications

Gets semantic highlights information for a particular file. Has two formats, an older version used by VS and a format used by VS Code.

getEncodedSyntacticClassifications

abstract fun getEncodedSyntacticClassifications(fileName: String, span: TextSpan): Classifications

Encoded as triples of start, length, ClassificationType.

getFileReferences

abstract fun getFileReferences(fileName: String): ReadonlyArray<ReferenceEntry>

getFormattingEditsAfterKeystroke

abstract fun getFormattingEditsAfterKeystroke(fileName: String, position: Double, key: String, options: FormatCodeOptions): ReadonlyArray<TextChange>

abstract fun getFormattingEditsAfterKeystroke(fileName: String, position: Double, key: String, options: FormatCodeSettings): ReadonlyArray<TextChange>

getFormattingEditsForDocument

abstract fun getFormattingEditsForDocument(fileName: String, options: FormatCodeOptions): ReadonlyArray<TextChange>

abstract fun getFormattingEditsForDocument(fileName: String, options: FormatCodeSettings): ReadonlyArray<TextChange>

getFormattingEditsForRange

abstract fun getFormattingEditsForRange(fileName: String, start: Double, end: Double, options: FormatCodeOptions): ReadonlyArray<TextChange>

abstract fun getFormattingEditsForRange(fileName: String, start: Double, end: Double, options: FormatCodeSettings): ReadonlyArray<TextChange>

getImplementationAtPosition

abstract fun getImplementationAtPosition(fileName: String, position: Double): ReadonlyArray<ImplementationLocation>?

getIndentationAtPosition

abstract fun getIndentationAtPosition(fileName: String, position: Double, options: EditorOptions): Double

abstract fun getIndentationAtPosition(fileName: String, position: Double, options: EditorSettings): Double

getJsxClosingTagAtPosition

abstract fun getJsxClosingTagAtPosition(fileName: String, position: Double): JsxClosingTagInfo?

This will return a defined result if the position is after the > of the opening tag, or somewhere in the text, of a JSXElement with no closing tag. Editors should call this after > is typed.

getLinkedEditingRangeAtPosition

abstract fun getLinkedEditingRangeAtPosition(fileName: String, position: Double): LinkedEditingInfo?

getMoveToRefactoringFileSuggestions

abstract fun getMoveToRefactoringFileSuggestions(fileName: String, positionOrRange: Double, preferences: UserPreferences?, triggerReason: RefactorTriggerReason = definedExternally, kind: String = definedExternally): LanguageServiceGetMoveToRefactoringFileSuggestionsResult

abstract fun getMoveToRefactoringFileSuggestions(fileName: String, positionOrRange: TextRange, preferences: UserPreferences?, triggerReason: RefactorTriggerReason = definedExternally, kind: String = definedExternally): LanguageServiceGetMoveToRefactoringFileSuggestionsResult

getNameOrDottedNameSpan

abstract fun getNameOrDottedNameSpan(fileName: String, startPos: Double, endPos: Double): TextSpan?

getNavigateToItems

abstract fun getNavigateToItems(searchValue: String, maxResultCount: Double = definedExternally, fileName: String = definedExternally, excludeDtsFiles: Boolean = definedExternally, excludeLibFiles: Boolean = definedExternally): ReadonlyArray<NavigateToItem>

getNavigationBarItems

abstract fun getNavigationBarItems(fileName: String): ReadonlyArray<NavigationBarItem>

getNavigationTree

abstract fun getNavigationTree(fileName: String): NavigationTree

getOutliningSpans

abstract fun getOutliningSpans(fileName: String): ReadonlyArray<OutliningSpan>

getProgram

abstract fun getProgram(): Program?

getQuickInfoAtPosition

abstract fun getQuickInfoAtPosition(fileName: String, position: Double): QuickInfo?

Gets semantic information about the identifier at a particular position in a file. Quick info is what you typically see when you hover in an editor.

getReferencesAtPosition

abstract fun getReferencesAtPosition(fileName: String, position: Double): ReadonlyArray<ReferenceEntry>?

getRenameInfo

abstract fun getRenameInfo(fileName: String, position: Double, options: RenameInfoOptions = definedExternally): RenameInfo

abstract fun getRenameInfo(fileName: String, position: Double, preferences: UserPreferences): RenameInfo

getSemanticClassifications

abstract fun getSemanticClassifications(fileName: String, span: TextSpan): ReadonlyArray<ClassifiedSpan>

abstract fun getSemanticClassifications(fileName: String, span: TextSpan, format: SemanticClassificationFormat): Any

getSemanticDiagnostics

abstract fun getSemanticDiagnostics(fileName: String): ReadonlyArray<Diagnostic>

Gets warnings or errors indicating type system issues in a given file. Requesting semantic diagnostics may start up the type system and run deferred work, so the first call may take longer than subsequent calls.

getSignatureHelpItems

abstract fun getSignatureHelpItems(fileName: String, position: Double, options: SignatureHelpItemsOptions?): SignatureHelpItems?

getSmartSelectionRange

abstract fun getSmartSelectionRange(fileName: String, position: Double): SelectionRange

getSpanOfEnclosingComment

abstract fun getSpanOfEnclosingComment(fileName: String, position: Double, onlyMultiLine: Boolean): TextSpan?

getSuggestionDiagnostics

abstract fun getSuggestionDiagnostics(fileName: String): ReadonlyArray<DiagnosticWithLocation>

Gets suggestion diagnostics for a specific file. These diagnostics tend to proactively suggest refactors, as opposed to diagnostics that indicate potentially incorrect runtime behavior.

getSupportedCodeFixes

abstract fun getSupportedCodeFixes(fileName: String = definedExternally): ReadonlyArray<String>

getSyntacticClassifications

abstract fun getSyntacticClassifications(fileName: String, span: TextSpan): ReadonlyArray<ClassifiedSpan>

abstract fun getSyntacticClassifications(fileName: String, span: TextSpan, format: SemanticClassificationFormat): Any

getSyntacticDiagnostics

abstract fun getSyntacticDiagnostics(fileName: String): ReadonlyArray<DiagnosticWithLocation>

Gets errors indicating invalid syntax in a file.

getTodoComments

abstract fun getTodoComments(fileName: String, descriptors: ReadonlyArray<TodoCommentDescriptor>): ReadonlyArray<TodoComment>

getTypeDefinitionAtPosition

abstract fun getTypeDefinitionAtPosition(fileName: String, position: Double): ReadonlyArray<DefinitionInfo>?

isValidBraceCompletionAtPosition

abstract fun isValidBraceCompletionAtPosition(fileName: String, position: Double, openingBrace: Double): Boolean

organizeImports

abstract fun organizeImports(args: OrganizeImportsArgs, formatOptions: FormatCodeSettings, preferences: UserPreferences?): ReadonlyArray<FileTextChanges>

prepareCallHierarchy

abstract fun prepareCallHierarchy(fileName: String, position: Double): Any?

provideCallHierarchyIncomingCalls

abstract fun provideCallHierarchyIncomingCalls(fileName: String, position: Double): ReadonlyArray<CallHierarchyIncomingCall>

provideCallHierarchyOutgoingCalls

abstract fun provideCallHierarchyOutgoingCalls(fileName: String, position: Double): ReadonlyArray<CallHierarchyOutgoingCall>

provideInlayHints

abstract fun provideInlayHints(fileName: String, span: TextSpan, preferences: UserPreferences?): ReadonlyArray<InlayHint>

toggleLineComment

abstract fun toggleLineComment(fileName: String, textRange: TextRange): ReadonlyArray<TextChange>

toggleMultilineComment

abstract fun toggleMultilineComment(fileName: String, textRange: TextRange): ReadonlyArray<TextChange>

uncommentSelection

abstract fun uncommentSelection(fileName: String, textRange: TextRange): ReadonlyArray<TextChange>