Skip to content

generateSidebarJson

Writes the Starlight sidebar of the API reference.

Import:

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

Signature:

function generateSidebarJson(types: Map<string, TypeInfo>): Promise<void>

Parameters:

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

Returns: Promise<void>