Interface TypeScriptWorker

Hierarchy

  • TypeScriptWorker

Methods

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

Methods

findRenameLocations

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

    Returns

    Promise<readonly typescript.RenameLocation[] | undefined>

    Parameters

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

    Returns Promise<readonly any[]>

getCodeFixesAtPosition

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

    Returns

    Promise<ReadonlyArray<typescript.CodeFixAction>>

    Parameters

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

      typescript.FormatCodeOptions

    Returns Promise<readonly any[]>

getCompilerOptionsDiagnostics

  • Get diagnostic messages related to the current compiler options.

    Parameters

    • fileName: string

      Not used

    Returns Promise<Diagnostic[]>

getCompletionEntryDetails

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

    Returns

    Promise<typescript.CompletionEntryDetails | undefined>

    Parameters

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

    Returns Promise<any>

getCompletionsAtPosition

  • Get code completions for the given file and position.

    Returns

    Promise<typescript.CompletionInfo | undefined>

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any>

getDefinitionAtPosition

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

    Returns

    Promise<ReadonlyArray<typescript.DefinitionInfo> | undefined>

    Parameters

    • fileName: string
    • position: number

    Returns Promise<readonly any[]>

getEmitOutput

  • Get transpiled output for the given file.

    Returns

    typescript.EmitOutput

    Parameters

    • fileName: string

    Returns Promise<EmitOutput>

getFormattingEditsAfterKeystroke

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

    Returns

    Promise<typescript.TextChange[]>

    Parameters

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

      typescript.FormatCodeOptions

    Returns Promise<any[]>

getFormattingEditsForDocument

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

    Returns

    Promise<typescript.TextChange[]>

    Parameters

    • fileName: string
    • options: any

      typescript.FormatCodeOptions

    Returns Promise<any[]>

getFormattingEditsForRange

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

    Returns

    Promise<typescript.TextChange[]>

    Parameters

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

      typescript.FormatCodeOptions

    Returns Promise<any[]>

getNavigationBarItems

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

    Returns

    Promise<typescript.NavigationBarItem[]>

    Parameters

    • fileName: string

    Returns Promise<any[]>

getOccurrencesAtPosition

  • Get other ranges which are related to the item at the given position in the file (often used for highlighting).

    Returns

    Promise<ReadonlyArray<typescript.ReferenceEntry> | undefined>

    Parameters

    • fileName: string
    • position: number

    Returns Promise<readonly any[]>

getQuickInfoAtPosition

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

    Returns

    Promise<typescript.QuickInfo | undefined>

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any>

getReferencesAtPosition

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

    Returns

    Promise<typescript.ReferenceEntry[] | undefined>

    Parameters

    • fileName: string
    • position: number

    Returns Promise<any[]>

getRenameInfo

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

    Returns

    Promise<typescript.RenameInfo>

    Parameters

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

      typescript.RenameInfoOptions

    Returns Promise<any>

getScriptText

  • Get the content of a given file.

    Parameters

    • fileName: string

    Returns Promise<string>

getSemanticDiagnostics

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

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

getSignatureHelpItems

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

    Returns

    Promise<typescript.SignatureHelpItems | undefined>

    Parameters

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

    Returns Promise<any>

getSuggestionDiagnostics

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

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

getSyntacticDiagnostics

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

    Parameters

    • fileName: string

    Returns Promise<Diagnostic[]>

provideInlayHints

  • Get inlay hints in the range of the file.

    Returns

    Promise<typescript.InlayHint[]>

    Parameters

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

    Returns Promise<readonly any[]>

Settings

Member Visibility

Theme