Interface TypeScriptWorker

interface TypeScriptWorker {
    findRenameLocations(fileName, positon, findInStrings, findInComments, providePrefixAndSuffixTextForRename): Promise<readonly any[]>;
    getCodeFixesAtPosition(fileName, start, end, errorCodes, formatOptions): Promise<readonly any[]>;
    getCompilerOptionsDiagnostics(fileName): Promise<Diagnostic[]>;
    getCompletionEntryDetails(fileName, position, entry): Promise<any>;
    getCompletionsAtPosition(fileName, position): Promise<any>;
    getDefinitionAtPosition(fileName, position): Promise<readonly any[]>;
    getDocumentHighlights(fileName, position, filesToSearch): Promise<readonly any[]>;
    getEmitOutput(fileName, emitOnlyDtsFiles?, forceDtsEmit?): Promise<EmitOutput>;
    getFormattingEditsAfterKeystroke(fileName, postion, ch, options): Promise<any[]>;
    getFormattingEditsForDocument(fileName, options): Promise<any[]>;
    getFormattingEditsForRange(fileName, start, end, options): Promise<any[]>;
    getNavigationTree(fileName): Promise<any>;
    getQuickInfoAtPosition(fileName, position): Promise<any>;
    getReferencesAtPosition(fileName, position): Promise<any[]>;
    getRenameInfo(fileName, positon, options): Promise<any>;
    getScriptText(fileName): Promise<string>;
    getSemanticDiagnostics(fileName): Promise<Diagnostic[]>;
    getSignatureHelpItems(fileName, position, options): Promise<any>;
    getSuggestionDiagnostics(fileName): Promise<Diagnostic[]>;
    getSyntacticDiagnostics(fileName): Promise<Diagnostic[]>;
    provideInlayHints(fileName, start, end): Promise<readonly any[]>;
}

Methods

findRenameLocations getCodeFixesAtPosition getCompilerOptionsDiagnostics getCompletionEntryDetails getCompletionsAtPosition getDefinitionAtPosition getDocumentHighlights getEmitOutput getFormattingEditsAfterKeystroke getFormattingEditsForDocument getFormattingEditsForRange getNavigationTree getQuickInfoAtPosition getReferencesAtPosition getRenameInfo getScriptText getSemanticDiagnostics getSignatureHelpItems getSuggestionDiagnostics getSyntacticDiagnostics provideInlayHints

Methods

findRenameLocations

  • findRenameLocations(fileName, positon, findInStrings, findInComments, providePrefixAndSuffixTextForRename): Promise<readonly any[]>

  • Get other occurrences which should be updated when renaming the item at the given file and position.

    Parameters

    • fileName: string
    • positon: number
    • findInStrings: boolean
    • findInComments: boolean
    • providePrefixAndSuffixTextForRename: boolean

    Returns Promise<readonly any[]>

    Promise<readonly typescript.RenameLocation[] | undefined>

getCodeFixesAtPosition

  • getCodeFixesAtPosition(fileName, start, end, errorCodes, formatOptions): Promise<readonly any[]>

  • Get possible code fixes at the given position in the file.

    Parameters

    • fileName: string
    • start: number
    • end: number
    • errorCodes: number[]
    • formatOptions: any

      typescript.FormatCodeOptions

    Returns Promise<readonly any[]>

    Promise<ReadonlyArray<typescript.CodeFixAction>>

getCompilerOptionsDiagnostics

  • getCompilerOptionsDiagnostics(fileName): Promise<Diagnostic[]>

  • Get diagnostic messages related to the current compiler options.

    Parameters

    • fileName: string

      Not used

    Returns Promise<Diagnostic[]>

getCompletionEntryDetails

  • getCompletionEntryDetails(fileName, position, entry): Promise<any>

  • Get code completion details for the given file, position, and entry.

    Parameters

    • fileName: string
    • position: number
    • entry: string

    Returns Promise<any>

    Promise<typescript.CompletionEntryDetails | undefined>

getCompletionsAtPosition

  • getCompletionsAtPosition(fileName, position): Promise<any>

  • Get code completions for the given file and position.

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any>

    Promise<typescript.CompletionInfo | undefined>

getDefinitionAtPosition

  • getDefinitionAtPosition(fileName, position): Promise<readonly any[]>

  • Get the definition of the item at the given position in the file.

    Parameters

    • fileName: string
    • position: number

    Returns Promise<readonly any[]>

    Promise<ReadonlyArray<typescript.DefinitionInfo> | undefined>

getDocumentHighlights

  • getDocumentHighlights(fileName, position, filesToSearch): Promise<readonly any[]>

  • Parameters

    • fileName: string
    • position: number
    • filesToSearch: string[]

    Returns Promise<readonly any[]>

getEmitOutput

  • getEmitOutput(fileName, emitOnlyDtsFiles?, forceDtsEmit?): Promise<EmitOutput>

  • Get transpiled output for the given file.

    Parameters

    • fileName: string
    • Optional emitOnlyDtsFiles: boolean
    • Optional forceDtsEmit: boolean

    Returns Promise<EmitOutput>

    typescript.EmitOutput

getFormattingEditsAfterKeystroke

  • getFormattingEditsAfterKeystroke(fileName, postion, ch, options): Promise<any[]>

  • Get formatting changes which should be applied after the given keystroke.

    Parameters

    • fileName: string
    • postion: number
    • ch: string
    • options: any

      typescript.FormatCodeOptions

    Returns Promise<any[]>

    Promise<typescript.TextChange[]>

getFormattingEditsForDocument

  • getFormattingEditsForDocument(fileName, options): Promise<any[]>

  • Get changes which should be applied to format the given file.

    Parameters

    • fileName: string
    • options: any

      typescript.FormatCodeOptions

    Returns Promise<any[]>

    Promise<typescript.TextChange[]>

getFormattingEditsForRange

  • getFormattingEditsForRange(fileName, start, end, options): Promise<any[]>

  • Get changes which should be applied to format the given range in the file.

    Parameters

    • fileName: string
    • start: number
    • end: number
    • options: any

      typescript.FormatCodeOptions

    Returns Promise<any[]>

    Promise<typescript.TextChange[]>

getNavigationTree

  • getNavigationTree(fileName): Promise<any>

  • Get outline entries for the item at the given position in the file.

    Parameters

    • fileName: string

    Returns Promise<any>

    Promise<typescript.NavigationTree | undefined>

getQuickInfoAtPosition

  • getQuickInfoAtPosition(fileName, position): Promise<any>

  • Get quick info for the item at the given position in the file.

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any>

    Promise<typescript.QuickInfo | undefined>

getReferencesAtPosition

  • getReferencesAtPosition(fileName, position): Promise<any[]>

  • Get references to the item at the given position in the file.

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any[]>

    Promise<typescript.ReferenceEntry[] | undefined>

getRenameInfo

  • getRenameInfo(fileName, positon, options): Promise<any>

  • Get edits which should be applied to rename the item at the given file and position (or a failure reason).

    Parameters

    • fileName: string
    • positon: number
    • options: any

      typescript.RenameInfoOptions

    Returns Promise<any>

    Promise<typescript.RenameInfo>

getScriptText

  • getScriptText(fileName): Promise<string>

  • Get the content of a given file.

    Parameters

    • fileName: string

    Returns Promise<string>

getSemanticDiagnostics

  • getSemanticDiagnostics(fileName): Promise<Diagnostic[]>

  • Get diagnostic messages for any semantic issues in the given file.

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

getSignatureHelpItems

  • getSignatureHelpItems(fileName, position, options): Promise<any>

  • Get signature help items for the item at the given file and position.

    Parameters

    • fileName: string
    • position: number
    • options: any

    Returns Promise<any>

    Promise<typescript.SignatureHelpItems | undefined>

getSuggestionDiagnostics

  • getSuggestionDiagnostics(fileName): Promise<Diagnostic[]>

  • Get diagnostic messages for any suggestions related to the given file.

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

getSyntacticDiagnostics

  • getSyntacticDiagnostics(fileName): Promise<Diagnostic[]>

  • Get diagnostic messages for any syntax issues in the given file.

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

provideInlayHints

  • provideInlayHints(fileName, start, end): Promise<readonly any[]>

  • Get inlay hints in the range of the file.

    Parameters

    • fileName: string
    • start: number
    • end: number

    Returns Promise<readonly any[]>

    Promise<typescript.InlayHint[]>

Settings

Member Visibility

Theme

On This Page

findRenameLocationsgetCodeFixesAtPositiongetCompilerOptionsDiagnosticsgetCompletionEntryDetailsgetCompletionsAtPositiongetDefinitionAtPositiongetDocumentHighlightsgetEmitOutputgetFormattingEditsAfterKeystrokegetFormattingEditsForDocumentgetFormattingEditsForRangegetNavigationTreegetQuickInfoAtPositiongetReferencesAtPositiongetRenameInfogetScriptTextgetSemanticDiagnosticsgetSignatureHelpItemsgetSuggestionDiagnosticsgetSyntacticDiagnosticsprovideInlayHints