[I] Program

Properties

Property	Modifier	Type	Description
checker	public	Checker	DANGER Using the checker is reserved for advanced usage and should be used with caution. API are not subject to the same stability guarantees see See https://typespec.io/docs/handbook/breaking-change-policy/
compilerOptions	public	CompilerOptions	-
diagnostics	readonly	readonly Diagnostic[]	-
emitters	public	EmitterRef[]	-
host	public	CompilerHost	-
jsSourceFiles	public	Map<string, JsSourceFileNode>	-
projectRoot	readonly	string	Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located.
sourceFiles	public	Map<string, TypeSpecScriptNode>	All source files in the program, keyed by their file path.
tracer	public	Tracer	-

Methods

getGlobalNamespaceType()

getGlobalNamespaceType(): Namespace;

Returns

Namespace

---

getSourceFileLocationContext()

getSourceFileLocationContext(sourceFile): LocationContext;

Return location context of the given source file.

Parameters

Parameter	Type
sourceFile	SourceFile

Returns

LocationContext

---

getTypeInfo()

getTypeInfo(target): TypeInfo | undefined;

Query the registered $onInfo providers for extra information about the given type. Returns the merged information contributed by every library, or undefined when none contributed. Providers are run lazily and never mutate the type graph. Used by the language server for hover docs and by tooling.

Requires the experimental type-info-hook compiler feature to be enabled; returns undefined otherwise.

Parameters

Parameter	Type
target	Type

Returns

TypeInfo | undefined

---

hasError()

hasError(): boolean;

Returns

boolean

---

reportDiagnostic()

reportDiagnostic(diagnostic): void;

Parameters

Parameter	Type
diagnostic	Diagnostic

Returns

void

---

reportDiagnostics()

reportDiagnostics(diagnostics): void;

Parameters

Parameter	Type
diagnostics	readonly Diagnostic[]

Returns

void

---

resolveTypeReference()

resolveTypeReference(reference): [Type | undefined, readonly Diagnostic[]];

Parameters

Parameter	Type
reference	string

Returns

[Type | undefined, readonly Diagnostic[]]

---

stateMap()

stateMap(key): Map<Type, any>;

Parameters

Parameter	Type
key	symbol

Returns

Map<Type, any>

---

stateSet()

stateSet(key): Set<Type>;

Parameters

Parameter	Type
key	symbol

Returns

Set<Type>

---

trace()

trace(area, message): void;

Parameters

Parameter	Type
area	string
message	string

Returns

void