API/vike-plugin-typedoc/TypedocContext

TypedocContext

interface
interface TypedocContext

PROPERTIES

NAMETYPEDESCRIPTION
apiDocsApiDocsAll parsed API documentation
baseUrlstringThe resolved base URL (from options.baseUrl, normalized)
navigationNavigationItem[]Navigation items for sidebar

METHODS

applyBaseUrl(path: string): string

Prepend the deployment base URL to a route-relative path

getAllPrerenderUrls(): string[]

Get all prerender URLs (packages + exports)

getExportUrls(): string[]

Get all export URLs (for pre-rendering)

getLinkedExport(packageSlug: string, symbolSlug: string): LinkedApiExport | null

Get a linked export by package + symbol slug

getPackage(packageSlug: string): ApiPackage | null

Get package info

getPackageUrls(): string[]

Get all package-level URLs (for pre-rendering)

getRehypePlugins(): Plugin[]

Get pre-configured rehype-typedoc plugins for use in custom unified pipelines

getTypeRef(exp: ApiExport): Type | undefined

Get the raw TypeDoc `Type` object for an export (server-side use only, never serialized). **Important:** `exp` must be the original `ApiExport` reference stored in `apiDocs` (e.g. from `apiDocs.packages[slug].exports`). Passing a `LinkedApiExport` returned by `getLinkedExport()` will always return `undefined` because `LinkedApiExport` is a shallow copy and will not match the WeakMap key.