renderTypeToHtml
functionfunction renderTypeToHtml(
type: Type,
resolveUrl: ResolveUrl,
options?: { format?: boolean; theme?: BundledTheme }
): Promise<string>;Render a TypeDoc Type to syntax-highlighted HTML with linked references.
Pipeline:
- Walk the type tree → plain string + range map
- Optionally format with prettier
- Tokenize with Shiki
- Merge tokens with ranges → HTML with
<a>links
PARAMETERS
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| type | Type | — |
| resolveUrl | ResolveUrl | — |
| options? | { format?: boolean; theme?: BundledTheme } | — |
RETURNS
Promise<string>