Shared data-model types for the API documentation generator.
| Interface |
Description |
| CodeSegment |
A fenced code block of a markdown text, with the language its fence names (empty when none). |
| EnumMemberInfo |
A documented enum member. |
| MemberInfo |
A documented property, method, constructor or function signature. |
| PageContent |
A generated page’s content and the path it is written to. |
| PageFrontMatter |
Frontmatter shared by every generated page. description and signature are optional because not every page has them, but a page that HAS one must emit it: both feed the page’s OG card. |
| ParameterInfo |
A documented parameter. |
| ProseSegment |
A run of markdown prose between code blocks. |
| ReturnTypeProvider |
The part of a ts-morph method or function the declared return type is read from. |
| SidebarEntry |
A collapsible Starlight sidebar group. |
| SidebarLink |
A Starlight sidebar link. |
| SidebarTreeNode |
Recursive tree node for building the sidebar |
| TextProvider |
A ts-morph node or type whose text can be printed. |
| TypeInfo |
A documented export: a class, interface, enum, type alias, function or variable. |
| WebApiEntry |
An object entry of the typedoc-plugin-mdn-links Web API data. |
| Type |
Description |
| MarkdownSegment |
A run of a markdown text: prose, or a fenced code block. |