typedoc-plugin-markdown/dist/theme/context/partials/type.reflection.function.js

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

import { backTicks } from '../../../libs/markdown/index.js';
export function functionType(model, options) {
    const shouldFormat = this.options.getValue('useCodeBlocks');
    const typeSeparator = options?.typeSeparator || ' => ';
    const functions = model.map((fn) => {
        const typeParams = fn.typeParameters
            ? `${this.helpers.getAngleBracket('<')}${fn.typeParameters
                .map((typeParameter) => backTicks(typeParameter.name))
                .join(', ')}${this.helpers.getAngleBracket('>')}`
            : '';
        const showParameterType = options?.forceParameterType || this.options.getValue('expandParameters');
        const params = fn.parameters
            ? fn.parameters.map((param) => {
                const paramType = this.partials.someType(param.type);
                const paramItem = [
                    `${param.flags?.isRest ? '...' : ''}${backTicks(`${param.name}${param.flags?.isOptional ? '?' : ''}`)}`,
                ];
                if (showParameterType) {
                    paramItem.push(paramType);
                }
                return paramItem.join(': ');
            })
            : [];
        const returns = this.partials.someType(fn.type);
        return (typeParams +
            `${shouldFormat && model.length > 1 ? '  ' : ''}(${params.join(', ')})${typeSeparator}${returns}`);
    });
    const join = shouldFormat ? ';\n' : '; ';
    return functions.join(join);
}