Interface Program

Hierarchy

ScriptReferenceHost
- Program

Methods

emit

emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult

- Defined in lib/typescript.d.ts:2071
Emits the JavaScript and declaration files. If targetSourceFile is not specified, then the JavaScript and declaration files will be produced for all the files in this program. If targetSourceFile is specified, then only the JavaScript and declaration for that specific file will be generated.

If writeFile is not specified then the writeFile callback from the compiler host will be used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter will be invoked when writing the JavaScript and declaration files.

Parameters
- Optional targetSourceFile: SourceFile
- Optional writeFile: WriteFileCallback
- Optional cancellationToken: CancellationToken
- Optional emitOnlyDtsFiles: boolean
- Optional customTransformers: CustomTransformers
Returns EmitResult

getCompilerOptions

getCompilerOptions(): CompilerOptions

Inherited from ScriptReferenceHost.getCompilerOptions
- Defined in lib/typescript.d.ts:2019
Returns CompilerOptions

getConfigFileParsingDiagnostics

getConfigFileParsingDiagnostics(): readonly Diagnostic[]

- Defined in lib/typescript.d.ts:2078
Returns readonly Diagnostic[]

getCurrentDirectory

getCurrentDirectory(): string

Overrides ScriptReferenceHost.getCurrentDirectory
- Defined in lib/typescript.d.ts:2052
Returns string

getDeclarationDiagnostics

getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[]

- Defined in lib/typescript.d.ts:2077
Parameters
- Optional sourceFile: SourceFile
- Optional cancellationToken: CancellationToken
Returns readonly DiagnosticWithLocation[]

getGlobalDiagnostics

getGlobalDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]

- Defined in lib/typescript.d.ts:2073
Parameters
- Optional cancellationToken: CancellationToken
Returns readonly Diagnostic[]

getIdentifierCount

getIdentifierCount(): number

- Defined in lib/typescript.d.ts:2085
Returns number

getInstantiationCount

getInstantiationCount(): number

- Defined in lib/typescript.d.ts:2088
Returns number

getNodeCount

getNodeCount(): number

- Defined in lib/typescript.d.ts:2084
Returns number

getOptionsDiagnostics

getOptionsDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]

- Defined in lib/typescript.d.ts:2072
Parameters
- Optional cancellationToken: CancellationToken
Returns readonly Diagnostic[]

getProjectReferences

getProjectReferences(): readonly ProjectReference[]

- Defined in lib/typescript.d.ts:2097
Returns readonly ProjectReference[]

getRelationCacheSizes

getRelationCacheSizes(): { assignable: number; identity: number; strictSubtype: number; subtype: number }

- Defined in lib/typescript.d.ts:2089
Returns { assignable: number; identity: number; strictSubtype: number; subtype: number }
- assignable: number
- identity: number
- strictSubtype: number
- subtype: number

getResolvedProjectReferences

getResolvedProjectReferences(): readonly ResolvedProjectReference[]

- Defined in lib/typescript.d.ts:2098
Returns readonly ResolvedProjectReference[]

getRootFileNames

getRootFileNames(): readonly string[]

- Defined in lib/typescript.d.ts:2056
Get a list of root file names that were passed to a 'createProgram'

Returns readonly string[]

getSemanticDiagnostics

getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]

- Defined in lib/typescript.d.ts:2076
The first time this is called, it will return global diagnostics (no location).

Parameters
- Optional sourceFile: SourceFile
- Optional cancellationToken: CancellationToken
Returns readonly Diagnostic[]

getSourceFile

getSourceFile(fileName: string): SourceFile

Inherited from ScriptReferenceHost.getSourceFile
- Defined in lib/typescript.d.ts:2020
Parameters
- fileName: string
Returns SourceFile

getSourceFileByPath

getSourceFileByPath(path: Path): SourceFile

Inherited from ScriptReferenceHost.getSourceFileByPath
- Defined in lib/typescript.d.ts:2021
Parameters
- path: Path
Returns SourceFile

getSourceFiles

getSourceFiles(): readonly SourceFile[]

- Defined in lib/typescript.d.ts:2060
Get a list of files in the program

Returns readonly SourceFile[]

getSymbolCount

getSymbolCount(): number

- Defined in lib/typescript.d.ts:2086
Returns number

getSyntacticDiagnostics

getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[]

- Defined in lib/typescript.d.ts:2074
Parameters
- Optional sourceFile: SourceFile
- Optional cancellationToken: CancellationToken
Returns readonly DiagnosticWithLocation[]

getTypeCatalog

getTypeCatalog(): readonly Type[]

- Defined in lib/typescript.d.ts:2083
Returns readonly Type[]

getTypeChecker

getTypeChecker(): TypeChecker

- Defined in lib/typescript.d.ts:2082
Gets a type checker that can be used to semantically analyze source files in the program.

Returns TypeChecker

getTypeCount

getTypeCount(): number

- Defined in lib/typescript.d.ts:2087
Returns number

isSourceFileDefaultLibrary

isSourceFileDefaultLibrary(file: SourceFile): boolean

- Defined in lib/typescript.d.ts:2096
Parameters
- file: SourceFile
Returns boolean

isSourceFileFromExternalLibrary

isSourceFileFromExternalLibrary(file: SourceFile): boolean

- Defined in lib/typescript.d.ts:2095
Parameters
- file: SourceFile
Returns boolean

Generated using TypeDoc