API/vike-plugin-typedoc/LinkedApiExport

LinkedApiExport

interface
interface LinkedApiExport extends ApiExport

A single exported symbol (function, type, interface, etc.).

PROPERTIES

NAMETYPEDESCRIPTION
descriptionHtml?stringPre-rendered HTML from comment.summary / description (markdown)
examplesHtml?string[]Pre-rendered HTML for each example (wrapped in code fences, syntax-highlighted)
methods?LinkedMethod[]—
parameters?LinkedParameter[]—
properties?LinkedProperty[]—
remarksHtml?stringPre-rendered HTML from comment.remarks (markdown)
returnTypeCodeHtml?stringReturn type rendered as a syntax-highlighted code block (from markdown pipeline)
returnTypeHtml?string—
signatureCodeHtml?stringSignature rendered as a syntax-highlighted code block (from type-renderer pipeline)
signatureHtml?stringFull signature with type references linked (e.g. function names, return types)
typeParameters?LinkedTypeParameter[]—