Skip to content

generateMemberPages

Writes one page per own property and per own method overload key of a class or interface.

Import:

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

Signature:

function generateMemberPages(name: string, info: TypeInfo, allTypes: Map<string, TypeInfo>): Promise<void>

Parameters:

Parameter Type Description
name string The type’s name.
info TypeInfo The documented type.
allTypes Map<string, TypeInfo> Every documented type, keyed by $\{namespace\}#$\{name\}.

Returns: Promise<void>