Skip to content

renderVariablePage

Renders a variable’s declaration and type.

Import:

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

Signature:

function renderVariablePage(lines: string[], name: string, info: TypeInfo, allTypes: Map<string, TypeInfo>): void

Parameters:

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

Returns: void