generateNamespaceIndexPages
Writes each module’s index page and the root API index.
Import:
import { generateNamespaceIndexPages } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-page-generation';Signature:
function generateNamespaceIndexPages(types: Map<string, TypeInfo>, allTypes: Map<string, TypeInfo>, moduleOverviews: Map<string, string>): Promise<void>Parameters:
| Parameter | Type | Description |
|---|---|---|
types |
Map<string, TypeInfo> | The documented types, keyed by qualified id. |
allTypes |
Map<string, TypeInfo> | Every documented type, keyed by $\{namespace\}#$\{name\}. |
moduleOverviews |
Map<string, string> | Each namespace’s @file overview. |