Class ProjectService

constructor

• new ProjectService(opts: ProjectServiceOptions): ProjectService

  Parameters

  • opts: ProjectServiceOptions

  Returns ProjectService

ReadonlyallowLocalPluginLoads

ReadonlycancellationToken

ReadonlyconfiguredProjects

ReadonlycurrentDirectory

ReadonlyexternalProjects

ReadonlyglobalPlugins

Readonlyhost

ReadonlyinferredProjects

ReadonlyjsDocParsingMode

Readonlylogger

ReadonlyopenFiles

ReadonlypluginProbeLocations

ReadonlyserverMode

Optional ReadonlythrottleWaitMilliseconds

ReadonlytoCanonicalFileName

ReadonlytypesMapLocation

ReadonlytypingsInstaller

ReadonlyuseInferredProjectPerProjectRoot

ReadonlyuseSingleInferredProject

applySafeList

• applySafeList(proj: tsc.server.protocol.ExternalProject): NormalizedPath[]

  Parameters

  • proj: tsc.server.protocol.ExternalProject

  Returns NormalizedPath[]

closeClientFile

• closeClientFile(uncheckedFileName: string): void

  Close file whose contents is managed by the client

  Parameters

  • uncheckedFileName: string

  Returns void

closeExternalProject

• closeExternalProject(uncheckedFileName: string): void

  Parameters

  • uncheckedFileName: string

  Returns void

closeLog

• closeLog(): void

  Returns void

configurePlugin

• configurePlugin(args: ConfigurePluginRequestArguments): void

  Parameters

  • args: ConfigurePluginRequestArguments

  Returns void

findProject

• findProject(projectName: string): tsc.server.Project | undefined

  Parameters

  • projectName: string

  Returns tsc.server.Project | undefined

getDefaultProjectForFile

• getDefaultProjectForFile(
      fileName: NormalizedPath,
      ensureProject: boolean,
  ): tsc.server.Project | undefined

  Parameters

  • fileName: NormalizedPath
  • ensureProject: boolean

  Returns tsc.server.Project | undefined

getFormatCodeOptions

• getFormatCodeOptions(file: NormalizedPath): tsc.FormatCodeSettings

  Parameters

  • file: NormalizedPath

  Returns tsc.FormatCodeSettings

getHostFormatCodeOptions

• getHostFormatCodeOptions(): tsc.FormatCodeSettings

  Returns tsc.FormatCodeSettings

getHostPreferences

• getHostPreferences(): tsc.UserPreferences

  Returns tsc.UserPreferences

getOrCreateScriptInfoForNormalizedPath

• getOrCreateScriptInfoForNormalizedPath(
      fileName: NormalizedPath,
      openedByClient: boolean,
      fileContent?: string,
      scriptKind?: tsc.ScriptKind,
      hasMixedContent?: boolean,
      hostToQueryFileExistsOn?: { fileExists(path: string): boolean },
  ): ScriptInfo | undefined

  Parameters

  • fileName: NormalizedPath
  • openedByClient: boolean
  • OptionalfileContent: string
  • OptionalscriptKind: tsc.ScriptKind
  • OptionalhasMixedContent: boolean
  • OptionalhostToQueryFileExistsOn: { fileExists(path: string): boolean }

  Returns ScriptInfo | undefined

getPreferences

• getPreferences(file: NormalizedPath): tsc.UserPreferences

  Parameters

  • file: NormalizedPath

  Returns tsc.UserPreferences

getScriptInfo

• getScriptInfo(uncheckedFileName: string): ScriptInfo | undefined

  Parameters

  • uncheckedFileName: string

  Returns ScriptInfo | undefined

getScriptInfoEnsuringProjectsUptoDate

• getScriptInfoEnsuringProjectsUptoDate(
      uncheckedFileName: string,
  ): ScriptInfo | undefined

  Parameters

  • uncheckedFileName: string

  Returns ScriptInfo | undefined

getScriptInfoForNormalizedPath

• getScriptInfoForNormalizedPath(fileName: NormalizedPath): ScriptInfo | undefined

  This gets the script info for the normalized path. If the path is not rooted disk path then the open script info with project root context is preferred

  Parameters

  • fileName: NormalizedPath

  Returns ScriptInfo | undefined

getScriptInfoForPath

• getScriptInfoForPath(fileName: tsc.Path): ScriptInfo | undefined

  Parameters

  • fileName: tsc.Path

  Returns ScriptInfo | undefined

hasDeferredExtension

• hasDeferredExtension(): boolean

  Returns boolean

openClientFile

• openClientFile(
      fileName: string,
      fileContent?: string,
      scriptKind?: tsc.ScriptKind,
      projectRootPath?: string,
  ): OpenConfiguredProjectResult

  Open file whose contents is managed by the client

  Parameters

  • fileName: string
  • OptionalfileContent: string

    is a known version of the file content that is more up to date than the one on disk

  • OptionalscriptKind: tsc.ScriptKind
  • OptionalprojectRootPath: string

  Returns OpenConfiguredProjectResult

openClientFileWithNormalizedPath

• openClientFileWithNormalizedPath(
      fileName: NormalizedPath,
      fileContent?: string,
      scriptKind?: tsc.ScriptKind,
      hasMixedContent?: boolean,
      projectRootPath?: NormalizedPath,
  ): OpenConfiguredProjectResult

  Parameters

  • fileName: NormalizedPath
  • OptionalfileContent: string
  • OptionalscriptKind: tsc.ScriptKind
  • OptionalhasMixedContent: boolean
  • OptionalprojectRootPath: NormalizedPath

  Returns OpenConfiguredProjectResult

openExternalProject

• openExternalProject(proj: tsc.server.protocol.ExternalProject): void

  Parameters

  • proj: tsc.server.protocol.ExternalProject

  Returns void

openExternalProjects

• openExternalProjects(projects: tsc.server.protocol.ExternalProject[]): void

  Parameters

  • projects: tsc.server.protocol.ExternalProject[]

  Returns void

reloadProjects

• reloadProjects(): void

  This function rebuilds the project for every file opened by the client This does not reload contents of open files from disk. But we could do that if needed

  Returns void

resetSafeList

• resetSafeList(): void

  Returns void

setCompilerOptionsForInferredProjects

• setCompilerOptionsForInferredProjects(
      projectCompilerOptions: InferredProjectCompilerOptions,
      projectRootPath?: string,
  ): void

  Parameters

  • projectCompilerOptions: InferredProjectCompilerOptions
  • OptionalprojectRootPath: string

  Returns void

setHostConfiguration

• setHostConfiguration(args: ConfigureRequestArguments): void

  Parameters

  • args: ConfigureRequestArguments

  Returns void

toPath

• toPath(fileName: string): tsc.Path

  Parameters

  • fileName: string

  Returns tsc.Path

updateTypingsForProject

• updateTypingsForProject(
      response:
          | SetTypings
          | InvalidateCachedTypings
          | PackageInstalledResponse,
  ): void

  Parameters

  • response: SetTypings | InvalidateCachedTypings | PackageInstalledResponse

  Returns void