Skip to content

renderMethodOverloadMdx

Renders one method overload.

Import:

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

Signature:

function renderMethodOverloadMdx(lines: string[], overload: MemberInfo, typeName: string, namespace: string, allTypes: Map<string, TypeInfo>): void

Parameters:

Parameter Type Description
lines string[] The page lines to append to.
overload MemberInfo The overload.
typeName string The name of the type the method belongs to.
namespace string The namespace of the type the method belongs to.
allTypes Map<string, TypeInfo> Every documented type, keyed by $\{namespace\}#$\{name\}.

Returns: void