Skip to content

[I] TypeSpecLibraryDef

Type ParameterDefault type
T extends object-
E extends Record<string, any>Record<string, never>
State extends stringnever
PropertyModifierTypeDescription
alias?readonlystringOptional 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.
capabilities?readonlyTypeSpecLibraryCapabilitiesOptional registration of capabilities the library/emitter provides
diagnosticsreadonlyDiagnosticMap<T>Map of potential diagnostics that can be emitted in this library where the key is the diagnostic code.
emitter?readonlyobjectEmitter configuration if library is an emitter.
emitter.options?publicJSONSchemaType<E>-
namereadonlystringLibrary name. MUST match package.json name.
requireImports?readonlyreadonly 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.
state?readonlyRecord<State, StateDef>-