Skip to content

resolveExternalTypeUrl

Resolve a type no page of this site documents to the page that does: another documented package’s site, or an entry of the site’s own externalTypeLinks setting.

Import:

import { resolveExternalTypeUrl } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-link-rendering';

Signature:

function resolveExternalTypeUrl(name: string): string | undefined

Parameters:

Parameter Type Description
name string The type’s name.

Returns: string | undefined — The URL, or undefined when neither knows the type.