docs-site/api-doc-jsdoc

JSDoc/declaration extraction: turns ts-morph declarations into the generator’s TypeInfo/MemberInfo.

Functions

Function	Description
extractClassInfo	Extracts a class’s model: its constructor, non-private properties and methods, and documentation.
extractConstructorInfo	Extracts a constructor’s model.
extractEnumInfo	Extracts an enum’s model.
extractFileOverview	Extract the module-level @file description text, if any.
extractInterfaceInfo	Extracts an interface’s model.
extractMethodInfo	Extracts a class method’s model.
extractMethodSignatureInfo	Extracts an interface method’s model.
extractPropertyInfo	Extracts a class property’s model.
extractPropertySignatureInfo	Extracts an interface property’s model.
extractTypeAliasInfo	Extracts a type alias’s model.
getDeclaredReturnType	Get the return type as declared in source (preserves union order), falling back to resolved type
getDescription	Extracts the JSDoc description of a node.
getExamples	Extract
getParameterDescriptions	Extract
getPropertyType	Strip | undefined only when it was implicitly added by ts-morph for optional properties
getRemarks	Extract
getReturnDescription	Extract
getSince	Extract the version a JSDoc since tag names.
resolveTypeofAliases	Resolve typeof aliasName patterns where aliasName is an import alias. E.g., typeof momentInstance → typeof moment when import \{ moment as momentInstance \}.