Skip to content

appendBacklinksAndWrite

Append backlinks to overview pages and write all files. Keyed by qualified ${namespace}#${name}.

Import:

import { appendBacklinksAndWrite } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-page-generation';

Signature:

function appendBacklinksAndWrite(pageContents: Map<string, PageContent>, allTypes: Map<string, TypeInfo>): Promise<void>

Parameters:

Parameter Type Description
pageContents Map<string, PageContent> Every overview page’s content and path, keyed by qualified id.
allTypes Map<string, TypeInfo> Every documented type, keyed by $\{namespace\}#$\{name\}.

Returns: Promise<void>