Skip to content

getPackageTypeUrl

Gets the page URL of a type declared in another documented package.

Import:

import { getPackageTypeUrl } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-package-sites';

Signature:

function getPackageTypeUrl(name: string): string | undefined

Parameters:

Parameter Type Description
name string The type’s name, as type text prints it.

Returns: string | undefined — The URL, or undefined when no documented package declares exactly one type of that name.