Skip to content

typeLink

Create an absolute link to a type page

Import:

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

Signature:

function typeLink(typeName: string, allTypes: Map<string, TypeInfo>, currentNamespace: string | undefined): string

Parameters:

Parameter Type Description
typeName string The type’s name.
allTypes Map<string, TypeInfo> Every documented type, keyed by $\{namespace\}#$\{name\}.
currentNamespace string | undefined The namespace of the referencing page, preferred when the name is ambiguous.

Returns: string — A markdown link, or inline code when the type is not documented.