Skip to content

buildSidebarTree

Builds the namespace tree the sidebar is generated from.

Import:

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

Signature:

function buildSidebarTree(types: Map<string, TypeInfo>): SidebarTreeNode

Parameters:

Parameter Type Description
types Map<string, TypeInfo> The documented types, keyed by qualified id.

Returns: SidebarTreeNode — The root of the tree.