Class ProjectAbstract

constructor

• new Project(): tsc.server.Project

  Returns tsc.server.Project

compileOnSaveEnabled

ReadonlyjsDocParsingMode

languageServiceEnabled

ReadonlyprojectKind

ReadonlyprojectService

Optional Readonlyrealpath

Optional Readonlytrace

addMissingFileRoot

• addMissingFileRoot(fileName: NormalizedPath): void

  Parameters

  • fileName: NormalizedPath

  Returns void

addRoot

• addRoot(info: ScriptInfo, fileName?: NormalizedPath): void

  Parameters

  • info: ScriptInfo
  • OptionalfileName: NormalizedPath

  Returns void

close

• close(): void

  Returns void

containsFile

• containsFile(filename: NormalizedPath, requireOpen?: boolean): boolean

  Parameters

  • filename: NormalizedPath
  • OptionalrequireOpen: boolean

  Returns boolean

containsScriptInfo

• containsScriptInfo(info: ScriptInfo): boolean

  Parameters

  • info: ScriptInfo

  Returns boolean

directoryExists

• directoryExists(path: string): boolean

  Parameters

  • path: string

  Returns boolean

disableLanguageService

• disableLanguageService(lastFileExceededProgramSize?: string): void

  Parameters

  • OptionallastFileExceededProgramSize: string

  Returns void

emitFile

• emitFile(
      scriptInfo: ScriptInfo,
      writeFile: (
          path: string,
          data: string,
          writeByteOrderMark?: boolean,
      ) => void,
  ): tsc.EmitResult

  Returns true if emit was conducted

  Parameters

  • scriptInfo: ScriptInfo
  • writeFile: (path: string, data: string, writeByteOrderMark?: boolean) => void

  Returns tsc.EmitResult

enableLanguageService

• enableLanguageService(): void

  Returns void

error

• error(s: string): void

  Parameters

  • s: string

  Returns void

fileExists

• fileExists(file: string): boolean

  Parameters

  • file: string

  Returns boolean

filesToString

• filesToString(writeProjectFileNames: boolean): string

  Parameters

  • writeProjectFileNames: boolean

  Returns string

getAllProjectErrors

• getAllProjectErrors(): readonly tsc.Diagnostic[]

  Get all the project errors

  Returns readonly tsc.Diagnostic[]

getCancellationToken

• getCancellationToken(): HostCancellationToken

  Returns HostCancellationToken

getCompilationSettings

• getCompilationSettings(): tsc.CompilerOptions

  Returns tsc.CompilerOptions

getCompileOnSaveAffectedFileList

• getCompileOnSaveAffectedFileList(scriptInfo: ScriptInfo): string[]

  Parameters

  • scriptInfo: ScriptInfo

  Returns string[]

getCompilerOptions

• getCompilerOptions(): tsc.CompilerOptions

  Returns tsc.CompilerOptions

getCurrentDirectory

• getCurrentDirectory(): string

  Returns string

getDefaultLibFileName

• getDefaultLibFileName(): string

  Returns string

getDirectories

• getDirectories(path: string): string[]

  Parameters

  • path: string

  Returns string[]

getExcludedFiles

• getExcludedFiles(): readonly NormalizedPath[]

  Returns readonly NormalizedPath[]

getExternalFiles

• getExternalFiles(updateLevel?: ProgramUpdateLevel): SortedReadonlyArray<string>

  Parameters

  • OptionalupdateLevel: ProgramUpdateLevel

  Returns SortedReadonlyArray<string>

getFileNames

• getFileNames(
      excludeFilesFromExternalLibraries?: boolean,
      excludeConfigFiles?: boolean,
  ): NormalizedPath[]

  Parameters

  • OptionalexcludeFilesFromExternalLibraries: boolean
  • OptionalexcludeConfigFiles: boolean

  Returns NormalizedPath[]

getGlobalProjectErrors

• getGlobalProjectErrors(): readonly tsc.Diagnostic[]

  Get the errors that dont have any file name associated

  Returns readonly tsc.Diagnostic[]

getLanguageService

• getLanguageService(ensureSynchronized?: boolean): tsc.LanguageService

  Parameters

  • OptionalensureSynchronized: boolean

  Returns tsc.LanguageService

getNewLine

• getNewLine(): string

  Returns string

getProjectName

• getProjectName(): string

  Returns string

getProjectReferences

• getProjectReferences(): readonly ProjectReference[] | undefined

  Returns readonly ProjectReference[] | undefined

getProjectVersion

• getProjectVersion(): string

  Returns string

getRootFiles

• getRootFiles(): NormalizedPath[]

  Returns NormalizedPath[]

getRootScriptInfos

• getRootScriptInfos(): ScriptInfo[]

  Returns ScriptInfo[]

getScriptFileNames

• getScriptFileNames(): string[]

  Returns string[]

getScriptInfo

• getScriptInfo(uncheckedFileName: string): ScriptInfo | undefined

  Parameters

  • uncheckedFileName: string

  Returns ScriptInfo | undefined

getScriptInfoForNormalizedPath

• getScriptInfoForNormalizedPath(fileName: NormalizedPath): ScriptInfo | undefined

  Parameters

  • fileName: NormalizedPath

  Returns ScriptInfo | undefined

getScriptInfos

• getScriptInfos(): ScriptInfo[]

  Returns ScriptInfo[]

getScriptKind

• getScriptKind(fileName: string): tsc.ScriptKind

  Parameters

  • fileName: string

  Returns tsc.ScriptKind

getScriptSnapshot

• getScriptSnapshot(filename: string): IScriptSnapshot | undefined

  Parameters

  • filename: string

  Returns IScriptSnapshot | undefined

getScriptVersion

• getScriptVersion(filename: string): string

  Parameters

  • filename: string

  Returns string

getSourceFile

• getSourceFile(path: tsc.Path): tsc.SourceFile | undefined

  Parameters

  • path: tsc.Path

  Returns tsc.SourceFile | undefined

getTypeAcquisition

• getTypeAcquisition(): TypeAcquisition

  Returns TypeAcquisition

hasConfigFile

• hasConfigFile(configFilePath: NormalizedPath): boolean

  Parameters

  • configFilePath: NormalizedPath

  Returns boolean

hasRoots

• hasRoots(): boolean

  Returns boolean

installPackage

• installPackage(
      options: InstallPackageOptions,
  ): Promise<ApplyCodeActionCommandResult>

  Parameters

  • options: InstallPackageOptions

  Returns Promise<ApplyCodeActionCommandResult>

isClosed

• isClosed(): boolean

  Returns boolean

isJsOnlyProject

• isJsOnlyProject(): boolean

  Returns boolean

isKnownTypesPackageName

• isKnownTypesPackageName(name: string): boolean

  Parameters

  • name: string

  Returns boolean

isNonTsProject

• isNonTsProject(): boolean

  Returns boolean

isRoot

• isRoot(info: ScriptInfo): boolean

  Parameters

  • info: ScriptInfo

  Returns boolean

log

• log(s: string): void

  Parameters

  • s: string

  Returns void

readDirectory

• readDirectory(
      path: string,
      extensions?: readonly string[],
      exclude?: readonly string[],
      include?: readonly string[],
      depth?: number,
  ): string[]

  Parameters

  • path: string
  • Optionalextensions: readonly string[]
  • Optionalexclude: readonly string[]
  • Optionalinclude: readonly string[]
  • Optionaldepth: number

  Returns string[]

readFile

• readFile(fileName: string): string | undefined

  Parameters

  • fileName: string

  Returns string | undefined

refreshDiagnostics

• refreshDiagnostics(): void

  Starts a new check for diagnostics. Call this if some file has updated that would cause diagnostics to be changed.

  Returns void

registerFileUpdate

• registerFileUpdate(fileName: string): void

  Parameters

  • fileName: string

  Returns void

removeFile

• removeFile(
      info: ScriptInfo,
      fileExists: boolean,
      detachFromProject: boolean,
  ): void

  Parameters

  • info: ScriptInfo
  • fileExists: boolean
  • detachFromProject: boolean

  Returns void

setCompilerOptions

• setCompilerOptions(compilerOptions: tsc.CompilerOptions): void

  Parameters

  • compilerOptions: tsc.CompilerOptions

  Returns void

setProjectErrors

• setProjectErrors(projectErrors: tsc.Diagnostic[] | undefined): void

  Parameters

  • projectErrors: tsc.Diagnostic[] | undefined

  Returns void

setTypeAcquisition

• setTypeAcquisition(newTypeAcquisition: TypeAcquisition | undefined): void

  Parameters

  • newTypeAcquisition: TypeAcquisition | undefined

  Returns void

updateGraph

• updateGraph(): boolean

  Updates set of files that contribute to this project @returns: true if set of files in the project stays the same and false - otherwise.

  Returns boolean

useCaseSensitiveFileNames

• useCaseSensitiveFileNames(): boolean

  Returns boolean

writeFile

• writeFile(fileName: string, content: string): void

  Parameters

  • fileName: string
  • content: string

  Returns void

StaticresolveModule

• resolveModule(
      moduleName: string,
      initialDir: string,
      host: ServerHost,
      log: (message: string) => void,
  ): {} | undefined

  Parameters

  • moduleName: string
  • initialDir: string
  • host: ServerHost
  • log: (message: string) => void

  Returns {} | undefined