Rich runtime representation of a module with computed properties.
library
type Library
module_json
type ModuleJson
path
Canonical module path (e.g., 'Alert.ts', 'helpers/foo.ts').
path_import
Import-style path with ./ prefix.
module_comment
declarations
Array of Declaration instances. Filters out default exports.
url_api
API documentation URL for this module.
url_github
GitHub source URL.
has_declarations
type boolean
has_module_comment
type boolean
dependencies
Modules this imports (paths relative to src/lib).
dependents
Modules that import this (paths relative to src/lib).
constructor
type new (library: Library, module_json: { [x: string]: unknown; path: string; declarations?: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; ... 19 more ...; alias_of?: { ...; } | undefined; }[] | undefined; module_comment?: string | undefined; dependencies?: string[] | undefined; dependents?: string[] | undefined; }): Module
library
module_json
{ [x: string]: unknown; path: string; declarations?: { [x: string]: unknown; name: string; kind: "function" | "type" | "json" | "variable" | "class" | "constructor" | "component" | "css"; doc_comment?: string | undefined; ... 18 more ...; alias_of?: { ...; } | undefined; }[] | undefined; module_comment?: string | un...get_declaration_by_name
Look up a declaration by name within this module.
type (name: string): Declaration | undefined
name
stringDeclaration | undefined