registerPackageDeclaration

Records where a type is declared, so its references link to its page on that package’s site.

A declaration outside every ApiDocSettings.packageSites package is ignored. A name two packages declare is remembered as ambiguous and never linked.

Import:

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

Signature:

function registerPackageDeclaration(name: string, declarationFilePath: string): void

Parameters:

Parameter	Type	Description
name	string	The type’s name.
declarationFilePath	string	The declaration file’s path, with or without its .d.mts / .d.cts extension.

Returns: void

---

Links to this page:

• clearPackageDeclarations