[I] TypeSpecLibrary

Library definition enriched with diagnostic, state-key, and tracing helpers by createTypeSpecLibrary.

Extends

• TypeSpecLibraryDef<T, E, State>

Type Parameters

Type Parameter	Default type
T extends object	-
E extends Record<string, any>	Record<string, never>
State extends string	never

Properties

Property	Modifier	Type	Description	Overrides	Inherited from
alias?	readonly	string	Optional short alias for this library used in diagnostic and linter rule codes. When provided, diagnostic/linter codes can be referenced as ${alias}/${code} in addition to the full ${name}/${code} form (e.g. tcgc/no-foo). Overrides the automatically scope-stripped short name.	-	TypeSpecLibraryDef.alias
capabilities?	readonly	TypeSpecLibraryCapabilities	Optional registration of capabilities the library/emitter provides	-	TypeSpecLibraryDef.capabilities
diagnostics	readonly	DiagnosticMap<T>	Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code.	-	TypeSpecLibraryDef.diagnostics
emitter?	readonly	object	Emitter configuration if library is an emitter. Its optional options JSON Schema validates custom configuration before the emitter runs; omit it when no schema is supplied.	-	TypeSpecLibraryDef.emitter
emitter.options?	public	JSONSchemaType<E>	-	-	-
name	readonly	string	Library name	TypeSpecLibraryDef.name	-
requireImports?	readonly	readonly string[]	List of other library that should be imported when this is used as an emitter. Compiler will emit an error if the libraries are not explicitly imported.	-	TypeSpecLibraryDef.requireImports
state?	readonly	Record<State, StateDef>	Named state definitions used to create the corresponding symbols in the library’s stateKeys map.	-	TypeSpecLibraryDef.state
stateKeys	readonly	Record<State, symbol>	Symbols for declared state names, registered as <library-name>/<state-name> for program state maps and sets.	-	-

Methods

createDiagnostic()

createDiagnostic<C, M>(diag): Diagnostic;

Creates a library-qualified diagnostic without reporting it; the caller owns reporting or returning it.

Type Parameters

Type Parameter
C extends string | number | symbol
M extends string | number | symbol

Parameters

Parameter	Type
diag	DiagnosticReport<T, C, M>

Returns

Diagnostic

---

createStateSymbol()

createStateSymbol(name): symbol;

Get or create a symbol with the given name unique for that library.

Parameters

Parameter	Type	Description
name	string	Symbol name scoped with the library name.

Returns

symbol

---

getTracer()

getTracer(program): Tracer;

Returns a tracer scopped to the current library. All trace area logged via this tracer will be prefixed with the library name.

Parameters

Parameter	Type
program	Program

Returns

Tracer

---

reportDiagnostic()

reportDiagnostic<C, M>(program, diag): void;

Creates a library-qualified diagnostic and reports it through the program’s reporting policies.

Type Parameters

Type Parameter
C extends string | number | symbol
M extends string | number | symbol

Parameters

Parameter	Type
program	Program
diag	DiagnosticReport<T, C, M>

Returns

void