TypeScript compiler API helpers for extracting metadata from source code.
All functions are prefixed with
ts_for clarity.
12 declarations
ModuleExportsAnalysis Result of analyzing a module's exports.
module_commentModule-level documentation comment.
stringdeclarationsAll exported declarations with their metadata (excludes same-name re-exports).
Array<DeclarationJson>re_exportsSame-name re-exports (for building also_exported_from in post-processing).
Array<ReExportInfo>ReExportInfo Information about a same-name re-export.
Used for post-processing to build also_exported_from arrays.
nameName of the re-exported declaration.
stringoriginal_moduleModule path (relative to src/lib) where the declaration is originally declared.
string(symbol: Symbol, source_file: SourceFile, checker: TypeChecker): TsDeclarationAnalysis Analyze a TypeScript symbol and extract rich metadata.
This is a high-level function that combines TSDoc parsing with TypeScript type analysis to produce complete declaration metadata. Suitable for use in documentation generators, IDE integrations, and other tooling.
symbolThe TypeScript symbol to analyze
Symbolsource_fileThe source file containing the symbol
SourceFilecheckerThe TypeScript type checker
TypeCheckerTsDeclarationAnalysis Complete declaration metadata including docs, types, and parameters, plus nodocs flag
(source_file: SourceFile, checker: TypeChecker): ModuleExportsAnalysis Analyze all exports from a TypeScript source file.
Extracts the module-level comment and all exported declarations with
complete metadata. Handles re-exports by:
- Same-name re-exports: tracked in re_exports for also_exported_from building
- Renamed re-exports: included as new declarations with alias_of metadata
This is a high-level function suitable for building documentation, API explorers, or analysis tools.
source_fileThe TypeScript source file to analyze
SourceFilecheckerThe TypeScript type checker
TypeCheckerModuleExportsAnalysis Module comment, array of analyzed declarations, and re-export information
(log: { warn: (message: string) => void; }): Program | null Create TypeScript program for analysis.
log{ warn: (message: string) => void; }Program | null (node: Node, _symbol: Symbol, checker: TypeChecker, declaration: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }): void Extract class information with rich member metadata.
nodeNode_symbolSymbolcheckerTypeCheckerdeclaration{ [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; doc_comment?: string | undefined; type_signature?: string | undefined; ... 17 more ...; alias_of?: { ...; } | undefined; }void (node: Node, symbol: Symbol, checker: TypeChecker, declaration: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }, tsdoc: TsdocParsedComment | undefined): void Extract function/method information including parameters with descriptions and default values.
nodeNodesymbolSymbolcheckerTypeCheckerdeclaration{ [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; doc_comment?: string | undefined; type_signature?: string | undefined; ... 17 more ...; alias_of?: { ...; } | undefined; }tsdocTsdocParsedComment | undefinedvoid (source_file: SourceFile): string | undefined Extract module-level comment.
Only accepts JSDoc/TSDoc comments (/** ... *\/) followed by a blank line to distinguish
them from identifier-level comments. This prevents accidentally treating function/class
comments as module comments. Module comments can appear after imports.
source_fileSourceFilestring | undefined (node: Node, _symbol: Symbol, checker: TypeChecker, declaration: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }): void Extract type/interface information with rich property metadata.
nodeNode_symbolSymbolcheckerTypeCheckerdeclaration{ [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; doc_comment?: string | undefined; type_signature?: string | undefined; ... 17 more ...; alias_of?: { ...; } | undefined; }void (node: Node, symbol: Symbol, checker: TypeChecker, declaration: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }): void Extract variable information.
nodeNodesymbolSymbolcheckerTypeCheckerdeclaration{ [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; doc_comment?: string | undefined; type_signature?: string | undefined; ... 17 more ...; alias_of?: { ...; } | undefined; }void (symbol: Symbol, node: Node): "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css" Infer declaration kind from symbol and node.
symbolSymbolnodeNode"function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css" TsDeclarationAnalysis Result of analyzing a single declaration.
declarationThe analyzed declaration metadata.
DeclarationJsonnodocsWhether the declaration is marked
boolean